From a9bcc2757b40d18ae03b5efe9a86e900d443a8d5 Mon Sep 17 00:00:00 2001 From: morph Date: Wed, 27 May 2020 01:21:24 +0200 Subject: [PATCH] update readme --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) 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