Add Docs/ Comments feature docs

main
earnest ma 2021-11-30 21:57:53 -05:00
parent 9edfd060ed
commit 3b8e81d0cb
Signed by: earnest ma
GPG Key ID: A343F43342EB6E2A
1 changed files with 15 additions and 0 deletions

View File

@ -52,3 +52,18 @@ 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.
## Docs/ Comments
Create a collapsible area at the bottom of the page to embed something like Etherpad, Hedgedoc, or a commenting plugin. `HUGO_ENV` must equal production to show, otherwise a message will show instead.
Overwrite this partial `layouts/partials/docscomments-content.html` with what to include.
This can be disabled on your entire site:
```toml
[params]
disableDocsComments = true
```
For a specific page: `disableDocsComments = true`