update readme

This commit is contained in:
morph 2020-05-27 01:21:24 +02:00
parent 9872248e95
commit a9bcc2757b

View file

@ -2,7 +2,7 @@
A minimal Hugo theme that respects your privacy and is easy on your bandwidth. A minimal Hugo theme that respects your privacy and is easy on your bandwidth.
smol is based on [Blank](https://github.com/Vimux/Blank) created by [Vimux](https://github.com/Vimux) smol is based on [Blank](https://github.com/Vimux/Blank) created by [Vimux](https://github.com/Vimux).
## Features ## Features
@ -25,6 +25,48 @@ Next, open `config.toml` in the base of the Hugo site and ensure the theme optio
theme = "smol" theme = "smol"
``` ```
Lastly, add the following lines to your `config.toml` to make use of all the menu entries in the header and the footer if you need them.
```
# Header
[menu]
[[menu.main]]
identifier = "posts"
name = "Posts"
url = "/posts/"
weight = 1
[[menu.main]]
identifier = "categories"
name = "Categories"
url = "/categories/"
weight = 2
[[menu.main]]
identifier = "tags"
name = "Tags"
url = "/tags/"
weight = 3
# Footer
[[menu.footer]]
name = "Github"
url = "https://github.com/example
weight = 1
[[menu.footer]]
name = "Mastodon"
url = "https://example.com/@user
weight = 2
[[menu.footer]]
name = "Imprint"
url = "/imprint"
weight = 3
```
For more information read the official [quick start guide](https://gohugo.io/getting-started/quick-start/) of Hugo. For more information read the official [quick start guide](https://gohugo.io/getting-started/quick-start/) of Hugo.
## Contributing ## Contributing