Skip to content

Commit 419bb6f

Browse files
authored
Update Readme.md
1 parent bca5573 commit 419bb6f

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

Readme.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This is a blog software completely written in C# / Blazor. The aim is to have it
88
## How does it work
99
The basic idea is that the content creator writes his posts in markdown language (like this readme file).
1010
The markdown will then be translated into HTML and displayed to the client. This gives an easy entry to writing posts with all the flexibility markdown has.
11-
This also includes source code snippets. Right now only C# is highlighted properly but other languages can be extended easily as the highlighting is done via highlight.js.
11+
This also includes source code snippets. Highlighting is done via [highlight.js](https://highlightjs.org/) with the monokai theme.
1212

1313
## In Action
1414
![overview](assets/overview.gif)
@@ -35,7 +35,7 @@ The appsettings.json file has a lot of options to customize the content of the b
3535
"BackgroundUrl": "assets/profile-background.webp",
3636
"ProfilePictureUrl": "assets/profile-picture.webp"
3737
},
38-
"PersistenceProvider": "SqlServer",
38+
"PersistenceProvider": "InMemory",
3939
"ConnectionString": "",
4040
"DatabaseName": "",
4141
"Auth0": {
@@ -98,6 +98,8 @@ Currently there are 4 Storage-Provider:
9898
* Sqlite - Based on EF Core, so it can be easily adapted for other Sql Dialects
9999
* SqlServer - Based on EF Core, so it can be easily adapted for other Sql Dialects
100100

101+
The default (when you clone the repository) is the `InMemory` option. That means everytime you restart the service, all posts and related objects are gone.
102+
101103
## Comment Section
102104
For comments the blog is using [giscus](https://giscus.app/) or [disqus](https://disqus.com/).
103105

@@ -158,7 +160,7 @@ The blog includes some of the most important tags to get indexed by a crawler. F
158160

159161
### Robots.txt
160162
In the wwwroot/ you can find a default robots.txt. It allows that the site gets completely indexed. If you want to tweak that behavior feel free.
161-
Also you can provide a sitemap.xml to get a better ranking. The blog can create a sitemap.xml on its own. For that login and click on the `Admin` button in the navigation bar and afterwards on `Sitemap`. There you can let the blog create a new one for you. This is especially helpful after you created a new blog post to make easier for indexer like Google.
163+
Also you can provide a sitemap.xml to get a better ranking. The blog can create a sitemap.xml on its own. For that login and click on the `Admin` button in the navigation bar and afterwards on `Sitemap`. There you can let the blog create a new one for you. This is especially helpful after you created a new blog post to make easier for indexer like Google.
162164

163165
### Open Graph Tags
164166
To get better results when for example shared via LinkedIn some of the `<meta property="og:tag">` tags are implemented.
@@ -178,4 +180,7 @@ Furthermore the following tags are set:
178180
| Tag | Index | Display Blog Post |
179181
| ---------------------------------------- | ------------------------------------ | ----------------------------- |
180182
| Title of the web page | Defined in AppConfiguration.BlogName | Title of the blogpost |
181-
| &lt;meta name="keyword" content="" /&gt; | not set | Tags defined in the Blog Post |
183+
| &lt;meta name="keyword" content="" /&gt; | not set | Tags defined in the Blog Post |
184+
185+
## RSS Feed
186+
This blog also offers a RSS feed ([RSS 2.0 specification](https://validator.w3.org/feed/docs/rss2.html)), which can be consumed by your users or programs like feedly. Just append `feed.rss` to your url or click on the RSS feed icon in the navigation bar to get the feed. The RSS feed does not expose the whole content of a given blog post but it's title and short description including some other tags like preview image, publishing date and so on.

0 commit comments

Comments
 (0)