public/hugo-internet-weblog
public/hugo-internet-weblog
1
0
Fork 0
Code Issues 4 Pull requests Projects 1 Releases 7 Packages Activity Actions

Update README.md

Browse source
This commit is contained in:
Stephan Hadan 2025-01-11 08:45:42 +01:00
parent fb5b99cc23
commit d654868451
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -6,7 +6,7 @@ The theme features a customizable bio-section and flickr-based photo stream in i
To see more, [check out my blog which is rendered with this theme](http://jnjosh.com) and see it's [configuration on Github](https://github.com/jnjosh/jnjosh.com).
![internet-weblog showing a Micropost.](https://github.com/jnjosh/internet-weblog/blob/main/images/screenshot.png)
![internet-weblog showing a Micropost.](https://git.hadan-it.com/stiebke/hugo-internet-weblog/raw/branch/main/images/screenshot.png)
## Contents
@ -57,7 +57,7 @@ It also assumes you want to display links to your sections of content (`posts`,
The theme works with other content types, but posts work best when grouped under `posts`. When using the `posts` (_note that it is plural_) content type you'll have a customized list page sorted by year and the default list page. Here's an example:
![Custom List Page sorted by Year](https://github.com/jnjosh/internet-weblog/raw/main/images/posts.png)
![Custom List Page sorted by Year](https://git.hadan-it.com/stiebke/hugo-internet-weblog/raw/branch/main/images/posts.png)
**Recommendation:** Organize your blog posts under the `posts` directory.
@ -129,7 +129,7 @@ externalurl = "http://kickstarter.com"
These posts are rendered slightly different with an → to signify that it is remote.
![External URL](https://github.com/jnjosh/internet-weblog/raw/main/images/linkpost.png)
![External URL](https://git.hadan-it.com/stiebke/hugo-internet-weblog/raw/branch/main/images/linkpost.png)
#### Specifying a featured image for social media
@ -160,7 +160,7 @@ If you want to enable a dark appearance, there is limited support for that. Curr
| `[params]` - `ShowCopyright` | `true` or `false` | No. If true, Copyright text will be added to the footer. |
| `[params]` - `EnablePreferredDarkAppearance` | `true` or `false` | No. If true, The viewers system dark mode is respected switching to a dark appearance. |
| `[params]` - `RSSEnabled` | `true` or `false` | No. If true, RSS pages will be generated. |
| `[params]` - `RSSSections` | `[ "Posts", "Microposts", "Photos" ]` | If you want RSS links in the menu, yes. These strings need to be the display name of the section where you want to have an RSS icon displayed. ![rss](https://github.com/jnjosh/internet-weblog/blob/master/images/rss.png) |
| `[params]` - `RSSSections` | `[ "Posts", "Microposts", "Photos" ]` | If you want RSS links in the menu, yes. These strings need to be the display name of the section where you want to have an RSS icon displayed. ![rss](https://git.hadan-it.com/stiebke/hugo-internet-weblog/raw/branch/main/images/rss.png) |
| `[params]` - `RSSMicropostTitles` | `true` or `false` | No. If false, Microposts RSS feeds will not have the title in included posts. If not present or true, nothing happens. |
| `[params]` - `YearlyMicroposts` | `true` or `false` | No. If true, Microposts will have a page with a yearly grouping just like the posts. If not present or false, the default of not having a micropost yearly grouping is applied. |
| `[params]` - `SummarizeMicroposts` | `true` or `false` | No. If true, Microposts will be summarized in the main list just like posts with a continue reading link. If not present or false, the default of not summarizing microposts is applied. |