Update README.md
This commit is contained in:
Junyi
GitHub
parent
bfb5aab0a7
commit
104b9fc4ec
158
README.md
158
README.md
@ -4,33 +4,15 @@ Anubis2 is another simple minimalist theme for [Hugo blog engine](https://gohugo
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
## Highlighted Features
|
||||
|
||||
- Dark mode (automatic / by switcher)
|
||||
- Pagination
|
||||
- Multiple taxonomies: tags, categories, authors
|
||||
- Multiple sections: posts, notes, etc with customization
|
||||
- Archive
|
||||
- Multilingual
|
||||
- Dark / Light mode
|
||||
- Table of Contents
|
||||
- Open Graph and Twitter Cards support
|
||||
- Mobile support
|
||||
- Social icons
|
||||
- Google Analytics
|
||||
- Umami Analytics
|
||||
- Comment systems: Disqus, ISSO, Utteranc.es, GraphComment, Giscus
|
||||
- Comment Support (Giscus, Disque, ISSO, Utterances, GraphComment)
|
||||
- Analytics (Google, Umami)
|
||||
- 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
|
||||
- Robots.txt
|
||||
- Favorite posts
|
||||
- Pagination on post single page
|
||||
- Optional "Read more" link
|
||||
- webmentions
|
||||
- Mobile Support
|
||||
|
||||
## Installation
|
||||
|
||||
@ -44,10 +26,7 @@ Inside the folder of your Hugo site run:
|
||||
|
||||
For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo.
|
||||
|
||||
## Getting started
|
||||
After installing the theme successfully it requires a just a few more steps to get your site running.
|
||||
|
||||
### Check your site
|
||||
### Run your site
|
||||
|
||||
In order to see your site in action, run Hugo's built-in local server.
|
||||
|
||||
@ -55,130 +34,9 @@ In order to see your site in action, run Hugo's built-in local server.
|
||||
|
||||
Now enter [`localhost:1313`](http://localhost:1313/) in the address bar of your browser.
|
||||
|
||||
## Feature Settings
|
||||
|
||||
### Dark Mode
|
||||
- `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)
|
||||
|
||||
### Table of Contents
|
||||
If `toc` param in `params` section of the config file is set to `true`,
|
||||
Table of Contents is generated for every post that is at least `tocWordCount`
|
||||
words long (`0` by default, also belongs to the `params` section of the config).
|
||||
|
||||
This behavior can be overridden on per-post basis
|
||||
by setting `toc` to either `true` or `false` in the front matter of a post.
|
||||
|
||||
|
||||
### Social icons
|
||||
#### Predefined icons
|
||||
To add icon from predefined list, add to `params.social` config:
|
||||
- id of social network
|
||||
- name for placeholder (usually it's your nickname or login)
|
||||
|
||||
Predefined list:
|
||||
- email
|
||||
- facebook
|
||||
- github
|
||||
- instagram
|
||||
- linkedin
|
||||
- mastodon (need full url)
|
||||
- patreon
|
||||
- reddit
|
||||
- snapchat
|
||||
- soundcloud
|
||||
- spotify
|
||||
- telegram
|
||||
- twitch
|
||||
- twitter
|
||||
- vk
|
||||
- youtube
|
||||
|
||||
Example:
|
||||
```
|
||||
- id: github
|
||||
name: gohugoio
|
||||
```
|
||||
Config like this generate github icon with "https://github.com/gohugoio" url.
|
||||
|
||||
#### Predefined icons with custom url
|
||||
To add predefined icon with custom url, add to `params.social` config:
|
||||
- id of social network
|
||||
- full url to your network
|
||||
|
||||
Example:
|
||||
```
|
||||
- id: github
|
||||
url: "https://github.com/gohugoio/hugo"
|
||||
```
|
||||
Config like this generate github icon with "https://github.com/gohugoio/hugo" url.
|
||||
|
||||
#### Custom icons
|
||||
To add custom icon, add to `params.social` config:
|
||||
- id of social network/site
|
||||
- full url to your network/site
|
||||
|
||||
Also you need to create directory `static/fa-icons` and add svg icon of your network/site with name equals to `id` from config.
|
||||
|
||||
Example:
|
||||
```
|
||||
- id: google
|
||||
url: "https://www.google.com/search?q=I'm+lucky"
|
||||
```
|
||||
Icon should be "static/fa-icons/google.svg"
|
||||
|
||||
If you want font awesome icons, download "Font Awesome For Desktop" and open svg directory.
|
||||
|
||||
### Google Analytics
|
||||
Only works for production environment.
|
||||
|
||||
### Multilingual mode
|
||||
Check config/example usage in [exampleSiteMultilingual](https://github.com/Junyi-99/hugo-theme-anubis2/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 social icon with link to site current language RSS.
|
||||
|
||||
### Robots.txt
|
||||
Based on environment.
|
||||
For production — allow all, for other — disallow all.
|
||||
|
||||
### Favorite posts
|
||||
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
|
||||
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.
|
||||
|
||||
### Webmentions
|
||||
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.
|
||||
|
||||
## Custom shortcodes
|
||||
### Video (for local videofiles)
|
||||
Example: `{{< video src="/media/movie.mp4" type="video/mp4" preload="auto" caption="Some caption" alt="Some alt" >}}`
|
||||
|
||||
## Contributing
|
||||
|
||||
If you find a bug or have an idea for a feature, feel free to write an [issue](https://github.com/Junyi-99/hugo-theme-anubis2/issues) or make a PR.
|
||||
|
||||
## TODO
|
||||
See [issues](https://github.com/Junyi-99/hugo-theme-anubis2/issues).
|
||||
|
||||
## License
|
||||
MIT
|
||||
|
||||
© Junyi
|
||||
2024
|
||||
MIT © Junyi, 2024
|
||||
|
||||
Loading…
Reference in New Issue
Block a user