Merge branch 'master' of https://github.com/Mitrichius/hugo-theme-anubis into add-isso-feed

This commit is contained in:
Jan Fader 2022-05-22 11:40:56 +02:00
commit f8c6877c16
No known key found for this signature in database
GPG key ID: 1A6BDEFB0E27FA44
52 changed files with 790 additions and 162 deletions

View file

@ -16,11 +16,12 @@ Anubis is a simple minimalist theme for [Hugo blog engine](https://gohugo.io/).
- Mobile support
- Social icons
- Google Analytics
- Disqus
- ISSO
- Utteranc.es
- Comment systems: Disqus, ISSO, Utteranc.es, GraphComment
- RSS feeds
- Related posts (Read Next section)
- Deploy via Netlify (config included in example site)
- Hiding posts from the RSS feed
- Hidden posts (available only by link)
- Translations (en, ru, fr, pl)
- Custom CSS/JS
- Multilingual mode
@ -80,8 +81,11 @@ params:
dateFormat: "2006-01-02"
paginationSinglePost: true
style: light-without-switcher
readMore: false
readMore: false # show read more button
readNextPosts: 5 # show 5 related posts, 0 by default
disableSummary: false
copyCodeButton: true # true by default
rssAsSocialIcon: true
# utteranc.es support
utterancesRepo: "" # mandatory
utterancesTheme: "" # optional
@ -101,6 +105,7 @@ params:
avatar: true # optional
avatar-bg: "#f0f0f0" # optional
feed: false # optional
graphcommentId: ""
webmentions:
url: https://yourdomain.com/webemntions/receive
login: hugo-theme-anubis
@ -131,9 +136,9 @@ Now enter [`localhost:1313`](http://localhost:1313/) in the address bar of your
### Dark Mode
Customize via `style` param in `params` section of config.
Options:
- `light-without-switcher` - light theme, without switcher, JS-free (by default)
- `dark-without-switcher` - dark theme, without switcher, JS-free
- `auto-without-switcher` - theme based on user system settings, without switcher, JS-free
- `light-without-switcher` - light theme, without switcher (by default)
- `dark-without-switcher` - dark theme, without switcher
- `auto-without-switcher` - theme based on user system settings, without switcher
- `light` - light theme by default, can be switched by user to dark theme and back. Theme settings are saved for user
- `dark` - dark theme by default, can be switched by user to light theme and back. Theme settings are saved for user
- `auto` - theme based on user system settings by default, can be switched by user to dark/light theme. Theme settings are saved for user (by default in example sites)
@ -202,15 +207,25 @@ Only works for production environment.
### Multilingual mode
Check config/example usage in [exampleSiteMultilingual](https://github.com/Mitrichius/hugo-theme-anubis/tree/master/exampleSiteMultilingual) directory and documentation on [Hugo site](https://gohugo.io/content-management/multilingual/).
### RSS
RSS is available by site url + /index.xml. Also available for specific language, section, taxonomy.
`rssAsSocialIcon` parameter enables rss sosial icon with link to site current language RSS.
### Robots.txt
Based on environment.
For production — allow all, for other — disallow all.
### Favorite posts
To mark posts as favorite just add `favorite: true` in post's front matter. It adds a "★" icon nearby post's title.
Add `favorite: true` to post front matter. It adds a "★" icon nearby post's title.
### Related posts (Read Next section)
Based on `readNextPosts` config parameter. Check [this article](https://gohugo.io/content-management/related/#configure-related-content) for configuration details.
### Hiding posts from RSS
To hide a post from the RSS feed, just add `disable_feed: true` to its front matter.
Add `disable_feed: true` to post front matter.
### Make post available only by link
Add `hidden: true` to post front matter. Post also is not available in RSS feed.
### Pagination on post single page
Enabled by `paginationSinglePost` param in `params` section of config.
@ -219,6 +234,9 @@ Enabled by `paginationSinglePost` param in `params` section of config.
To provide webmention support you can **either** specify your webmention.io username with `login: webmentionusername` **or** specify a link to your custom webmention endpoint with `url: https://yourdomain.com/webemntions/receive`.
If you use webmention.io you can also enable pingback with `pingback: true`
### Disabling comments per-page basis
Add `disableComments: true` to post front matter.
## Contributing
If you find a bug or have an idea for a feature, feel free to write an [issue](https://github.com/mitrichius/hugo-theme-anubis/issues) or make a PR.