Update configuration docs section

* Update `subtitle` documentation to note that HTML escape sequences are
restricted by the new Goldmark rendering engine
* Add documentation for the `mainSections` parameter
pull/3/head v0.1.5
Kevin C. Coram 2019-11-29 11:16:12 -05:00
parent c9621cb516
commit b0780f91e1
Signed by: kevin
GPG Key ID: 0342351B3D61AD35
1 changed files with 20 additions and 2 deletions

View File

@ -35,16 +35,34 @@ As a very basic theme, there is very little to be configured via the `config.tom
file. file.
The footer layout file uses Hugo's `markdownify` pipe to display the `copyright` The footer layout file uses Hugo's `markdownify` pipe to display the `copyright`
configuration setting, providing support both for HTML5 character escape configuration setting, providing support both for HTML character escape
sequences such as `©` as well as markdwn formatting and links. sequences such as `©` as well as markdwn formatting and links.
The only non-standard configuration setting is the `subtitle` parameter: Note: Hugo versions 0.60.0 and up will have restrictions on using embedded HTML,
including escape secquences, unless the Goldmark renderer is configure with
`unsafe = true`.
### `subtitle` parameter
Setting the `subtitle` parameter adds a secondary header underneath the `title`
in the site header.
```toml ```toml
[params] [params]
subtitle = "A sub-title for your site" subtitle = "A sub-title for your site"
``` ```
### `mainSections` parameter
Setting the `mainSections` parameter restricts the pages that appear on the
homepage.
```toml
[params]
mainSections = ["posts"]
```
## Theme Organization ## Theme Organization
### Semantic Content Organization ### Semantic Content Organization