Skip to content

Commit da6049f

Browse files
committed
docs: Update many readmes
1 parent 0643939 commit da6049f

File tree

5 files changed

+32
-14
lines changed

5 files changed

+32
-14
lines changed

docs/Comments/Disqus.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ In `appsettings.json` change following
1515
| Property | Type | Description |
1616
| --------- | ------ | ------------------------------------------------------------------------------------------- |
1717
| Disqus | node | Enables the comment section via disqus. If left empty the comment secion will not be shown. |
18-
| Shortname | string | |
18+
| Shortname | string | The shortname provided by the disqus homepage |

docs/Comments/Giscus.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ In `appsettings.json` change following
4141
| Property | Type | Description |
4242
| ------------ | ------ | ------------------------------------------------------------------------------------------- |
4343
| Giscus | node | Enables the comment section via giscus. If left empty the comment secion will not be shown. |
44-
| Repository | string | path of you github repository, example `linkdotnet/Blog` |
45-
| RepositoryId | string | |
46-
| Category | string | |
47-
| CategoryId | string | |
44+
| Repository | string | Path of you github repository, example `linkdotnet/Blog` |
45+
| RepositoryId | string | The id provided by giscus (`data-repository-id`) |
46+
| Category | string | The "Category" under which the comments are histed (like "Q&A", "General", "Ideas", ...) |
47+
| CategoryId | string | The id provided by giscus (`data-category-id`) |

docs/Donations/Readme.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ Enables the usage of [Patreon](https://www.patreon.com). Only pass the user name
1818
### Configuration
1919
```json
2020
"SupportMe": {
21-
"KofiToken": "ABC123",
22-
"GithubSponsorName": "your-tag-here",
23-
"PatreonName": "your-tag-here",
24-
"ShowUnderBlogPost": true,
25-
"ShowUnderIntroduction": true,
26-
"ShowInFooter": true,
27-
"ShowSupportMePage": true,
28-
"SupportMePageDescription": "Buy my book here: [My Blazor Book](https://google.com) or please contribute to my open-source project here: [My Awesome Repo](https://github.com) . This can be **markdown**."
21+
"KofiToken": "ABC123",
22+
"GithubSponsorName": "your-tag-here",
23+
"PatreonName": "your-tag-here",
24+
"ShowUnderBlogPost": true,
25+
"ShowUnderIntroduction": true,
26+
"ShowInFooter": true,
27+
"ShowSupportMePage": true,
28+
"SupportMePageDescription": "Buy my book here: [My Blazor Book](https://google.com) or please contribute to my open-source project here: [My Awesome Repo](https://github.com) . This can be **markdown**."
2929
}
3030
```
3131

docs/Features/AdvancedFeatures.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
## Advanced Features
22

3+
- [Advanced Features](#advanced-features)
4+
- [Shortcodes](#shortcodes)
5+
- [Creating a shortcode](#creating-a-shortcode)
6+
- [Using a shortcode](#using-a-shortcode)
7+
- [Limitations](#limitations)
8+
- [Critical CSS Generator](#critical-css-generator)
9+
- [How it works](#how-it-works)
10+
- [Options](#options)
11+
- [Output Modes](#output-modes)
12+
- [Console Mode](#console-mode)
13+
- [File Mode](#file-mode)
14+
- [Layout Mode](#layout-mode)
15+
- [Examples](#examples)
16+
- [Notes](#notes)
17+
318
This page lists some of the more advanced or less-used features of the blog software.
419

520
## Shortcodes
@@ -62,7 +77,7 @@ The output of the "critical.css" should be copied into the head of the [`_Layout
6277

6378
## Output Modes
6479

65-
### #Console Mode
80+
### Console Mode
6681
Outputs the critical CSS directly to the console:
6782

6883
```sh

docs/SEO/Readme.md

+3
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,8 @@ This blog also offers an RSS feed ([RSS 2.0 specification](https://validator.w3.
3636

3737
This blog offers to generate a [sitemap](https://developers.google.com/search/docs/crawling-indexing/sitemaps/build-sitemap) that lists all blog posts, the archive and pages of the blog. A sitemap can be generated in the Admin tab of the navigation bar under "Sitemap". This allows, especially new sites that don't have many inbound links, to be indexed easier by search engines.
3838

39+
## JSON LD
40+
This blog supports a JSON-LD for structured data. The current support is limited / rudimentary. Information like `Headline` (the title of the blog post), `Author`, `PublishDated` and `PreviewImage` are present.
41+
3942
## Critical CSS
4043
The blog offers an integrated tool, that generates critical CSS for the blog. Read more about it in the ["*Advanced Features*"](../Features/AdvancedFeatures.md) section.

0 commit comments

Comments
 (0)