From 9edfd060ed3b09a43268d2930bc2ebd4a828892f Mon Sep 17 00:00:00 2001 From: earnest ma Date: Tue, 30 Nov 2021 10:07:29 -0500 Subject: [PATCH] Bring docs current --- configuration.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/configuration.md b/configuration.md index 460f763..0416f07 100644 --- a/configuration.md +++ b/configuration.md @@ -1,3 +1,54 @@ --- title: Configuration --- + +## config.toml + +```toml +baseURL = "https://example.org/" +languageCode = "en-us" +title = "Your digital garden" +theme = ["nwt"] # you do not need this if using as a Hugo module +copyright = "(c) " + +enableEmoji = true +enableGitInfo = true + +[author] +name = "" + +[params] + favicon = "/favicon.ico" # Place in static/favicon.ico + GitRepo = "" # Your git repo URL (no trailing slash needed) + +[[menu.main]] + name = "Wiki" + url = "/wiki" + weight = 100 + +[[menu.main]] + name = "External link" + url = "https://example.org" + weight = 200 + +``` + +## Expected files + +`content/wiki/_index.md` with a `title: Index` set. + +## Pinned pages + +Pinned pages will show on the top menu bar after your `main` menu items. You can easily set this in the page metadata with `menu: pinned`. + +## Footer pages + +`menu: footer` + +## Table of Contents + +To enable table of contents for a pages, set `enabletoc: true`. + +## Custom partials + +The partial `head-custom.html` is applied after `head.html`, you can create your own copy at `layouts/partials/head-custom.html` to overwrite it.