Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/colorchestra/smol.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormorph <morph@posteo.de>2020-05-27 02:21:24 +0300
committermorph <morph@posteo.de>2020-05-27 02:21:24 +0300
commita9bcc2757b40d18ae03b5efe9a86e900d443a8d5 (patch)
treee8e26ba2c65994cba187bb11d8b59edc272ec6fc
parent9872248e953aef0cba54355bae716f582a73de43 (diff)
update readme
-rw-r--r--README.md44
1 files changed, 43 insertions, 1 deletions
diff --git a/README.md b/README.md
index e740738..6665aed 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
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
@@ -25,6 +25,48 @@ Next, open `config.toml` in the base of the Hugo site and ensure the theme optio
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.
## Contributing