Skip to content

Commit cedab28

Browse files
committed
Updated documentation
1 parent 30b9a89 commit cedab28

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

Readme.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The appsettings.json file has a lot of options to customize the content of the b
2323
```json
2424
{
2525
"BlogName": "linkdotnet",
26+
"BlogBrandUrl": "http//some.url/image.png",
2627
"GithubAccountUrl": "",
2728
"LinkedInAccountUrl": "",
2829
"Introduction": {
@@ -59,11 +60,12 @@ The appsettings.json file has a lot of options to customize the content of the b
5960

6061
| Property | Type | Description |
6162
| ------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
62-
| BlogName | string | Name of your blog. Is used in the navbar and is used as the title of the page. |
63+
| BlogName | string | Name of your blog. Is used in the navbar and is used as the title of the page. Will not be shown when `BlogBrandUrl` is set |
64+
| BlogBrandUrl | string | The url to an image which is used as a brand image in the navigation bar. If not set or `null` the `BlogName` will be shown |
6365
| GithubAccountUrl | string | Url to your github account. If not set the navigation link is not shown |
6466
| LinkedInAccountUrl | string | Url to your LinkedIn account. If not set the navigation link is not shown |
6567
| Introduction | | Is used for the introduction part of the blog |
66-
| Description | MarkdownString | Small introduction text for yourself. This is also used for `<meta name="description">` tag. For this the markup will be converted to plain text. |
68+
| Description | MarkdownString | Small introduction text for yourself. This is also used for `<meta name="description">` tag. For this the markup will be converted to plain text |
6769
| BackgroundUrl | string | Url or path to the background image |
6870
| ProfilePictureUrl | string | Url or path to your profile picture |
6971
| PersistenceProvider | string | Declares the type of the storage provider (one of the following: `SqlServer`, `SqliteServer`, `RavenDb`, `InMemory`). More in-depth explanation down below |
@@ -161,4 +163,4 @@ Furthermore the following tags are set:
161163
| Tag | Index | Display Blog Post |
162164
| ---------------------------------------- | ------------------------------------ | ----------------------------- |
163165
| Title of the web page | Defined in AppConfiguration.BlogName | Title of the blogpost |
164-
| &lt;meta name="keyword" content="" /&gt; | not set | Tags defined in the Blog Post |
166+
| &lt;meta name="keyword" content="" /&gt; | not set | Tags defined in the Blog Post |

src/LinkDotNet.Blog.Web/appsettings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
},
99
"AllowedHosts": "*",
1010
"BlogName": "Blogname",
11+
"BlogBrandUrl": null,
1112
"GithubAccountUrl": "",
1213
"LinkedInAccountUrl": "",
1314
"Introduction": {

0 commit comments

Comments
 (0)