You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Readme.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,18 +93,18 @@ The appsettings.json file has a lot of options to customize the content of the b
93
93
| GithubSponsorName | string | Enables the "Github Sponsor" button which redirects to GitHub. Only pass in the user name instead of the url. |
94
94
95
95
## Storage Provider
96
-
Currently there are 4 Storage-Provider:
96
+
Currently, there are 4 Storage-Provider:
97
97
* InMemory - Basically a list holding your data (per request). If the User hits a hard reload, the data is gone.
98
98
* RavenDb - As the name suggests for RavenDb. RavenDb automatically creates all the documents, if a database name is provided.
99
-
* Sqlite - Based on EF Core, so it can be easily adapted for other Sql Dialects. The tables are automatically created.
100
-
* SqlServer - Based on EF Core, so it can be easily adapted for other Sql Dialects. The tables are automatically created.
99
+
* Sqlite - Based on EF Core, it can be easily adapted for other Sql Dialects. The tables are automatically created.
100
+
* SqlServer - Based on EF Core, it can be easily adapted for other Sql Dialects. The tables are automatically created.
101
101
102
-
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
+
The default (when you clone the repository) is the `InMemory` option. That means every time you restart the service, all posts and related objects are gone.
103
103
104
104
## Comment Section
105
-
For comments the blog is using [giscus](https://giscus.app/) or [disqus](https://disqus.com/).
105
+
For comments, the blog is using [giscus](https://giscus.app/) or [disqus](https://disqus.com/).
106
106
107
-
**Note**: Please only register one service / provide the configuration for one node. The given configuration shows both only for demonstrational purposes.
107
+
**Note**: Please only register one service or provide the configuration for one of the nodes. The given configuration shows both only for demonstrational purposes.
108
108
If multiple comment plugins are configured at the same time a warning will be displayed under the blog post itself.
109
109
110
110
### Giscus
@@ -129,7 +129,7 @@ In short:
129
129
async>
130
130
</script>
131
131
```
132
-
Now you can copy/paste those information into the appsettings.json. With the given information abobe your appsettings.json looks like this:
132
+
Now you can copy/paste that information into the appsettings.json. With the given information above your appsettings.json looks like this:
133
133
```json
134
134
"Giscus": {
135
135
"Repository": "your_username/reponame",
@@ -140,31 +140,31 @@ Now you can copy/paste those information into the appsettings.json. With the giv
140
140
```
141
141
142
142
### Disqus
143
-
For disqus you only need the shortname (site-name) which you can find for example under your [home-tab](https://disqus.com/home/).
143
+
For disqus you only need the short name (site-name) which you can find for example under your [home-tab](https://disqus.com/home/).
144
144
145
145
## Authorization
146
146
There is only one real mechanism enabled via Auth0. For more information go to: https://auth0.com/docs/applications
147
147
148
-
The main advantage of Auth0 is the easy configurable dashboard on their website.
148
+
The main advantage of Auth0 is the easily configurable dashboard on their website.
149
149
150
150
For testing purposes you can use `services.UseDummyAuthentication();`. This allows every user, who presses Login, to be logged in.
151
151
152
152
## Donations
153
-
The blog software allows you to integrate via different micro-transaction services. The following chapter will show you how to setup donations.
153
+
The blog software allows you to integrate via different micro-transaction services. The following chapter will show you how to set up donations.
154
154
155
155
### Ko-fi
156
-
You can use [Ko-fi](https://Ko-fi.com/) as payment service to receive donations. To aquire the `KofiToken` as seen in the config above, head to [wdigets page](https://Ko-fi.com/manage/widgets), click on "Ko-fi Button".
156
+
You can use [Ko-fi](https://Ko-fi.com/) as a payment service to receive donations. To acquire the `KofiToken` as seen in the config above, head to [widgets page](https://Ko-fi.com/manage/widgets), click on "Ko-fi Button".
157
157
Now choose "Image" as type. In the field below under `Copy & Paste Code` you see an `<a href='https://ko-fi.com/XYZ'` tag. Just take the `XYZ` part and put it into `KofiToken`.
158
158
159
159
### GitHub Sponsor
160
-
Enables the usage of [GitHub Sponsors](https://github.com/sponsors) as payment service to receive donations. Only pass in your username. The button will use the following url: `https://github.com/sponsors/{your-user-name}`.
160
+
Enables the usage of [GitHub Sponsors](https://github.com/sponsors) as a payment service to receive donations. Only pass in your username. The button will use the following url: `https://github.com/sponsors/{your-user-name}`.
161
161
162
162
## Search Engine Optimization (SEO)
163
-
The blog includes some of the most important tags to get indexed by a crawler. Furthermore some aspects of the Open Graph specification are implemented.
163
+
The blog includes some of the most important tags to get indexed by a crawler. Furthermore, some aspects of the Open Graph specification are implemented.
164
164
165
165
### Robots.txt
166
-
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.
167
-
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.
166
+
In the wwwroot/ you can find a default robots.txt. It allows the site gets completely indexed. If you want to tweak that behavior - feel free.
167
+
Also, you can provide a sitemap.xml to get a better ranking. The blog can create a sitemap.xml on its own. For that log in and click on the `Admin` button in the navigation bar and afterward 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 it easier for indexers like Google.
168
168
169
169
### Open Graph Tags
170
170
To get better results when for example shared via LinkedIn some of the `<meta property="og:tag">` tags are implemented.
@@ -179,12 +179,12 @@ The following tags are set depending on the page:
179
179
| og:type| article | article |
180
180
| og:description| Short description in plain text (defined in Introduction) | Short Description of Blog Post in plain text |
| Title of the web page | Defined in AppConfiguration.BlogName | Title of the blogpost |
187
187
|<meta name="keyword" content="" />| not set | Tags defined in the Blog Post |
188
188
189
189
## RSS Feed
190
-
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.
190
+
This blog also offers an 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 its title and short description including some other tags like preview image, publishing date and so on.
0 commit comments