diff options
author | Gerry <git@caulfield.me> | 2020-06-11 14:12:45 +0300 |
---|---|---|
committer | Gerry <git@caulfield.me> | 2020-06-11 14:34:08 +0300 |
commit | 6d09d970359388bf45f3749719d9e91fa5d0b3cd (patch) | |
tree | 5f6d4dde0a26a42b01c1cab850d3ca96b0d470e4 | |
parent | bdbd8d844fcdfa87f54620a609009ee8750ea671 (diff) |
Add documentation for page-level params
There previously wasn't documentation for things such as disabling
comments on a page or removing the table of contents despite these
features existing. This commit documents all the page-level params I
could find as well as their defaults.
I've also updated the example config so that it shows all params.
-rw-r--r-- | README.md | 36 |
1 files changed, 34 insertions, 2 deletions
@@ -121,19 +121,51 @@ keywords: --- ``` -Example usage: +#### page-level params + +hugo-primer also comes with some custom page level parameters + +- __showDate__ (default: __true__) +shows the date on a post + +- __comments__ (default: __true__) +setting to false will hide disqus comments + +- __toc__ (default: __true__) +display the table of contents + +- __categories__ (default: __an empty list__) +a list of categories to display in the sidebar + +- __tags__ (default: __an empty list__) +a list of tags to display in the sidebar + +- __math__ (default: __false__) +If math.js is disabled for the site you can use this setting to enable it for a single page + +- __keywords__ (default: __an empty list__) +This adds a metatag to the page for listing keywords. This can be useful for SEO. + + +Example usage where the defaults are overridden: ```md --- +showdate: false +comments: false +toc: false categories: - Diary tags: - Shopping - Health +math: true +keywords: +- Cheese +- Milk --- ``` -Set keywords for seo. #### ruby annotation |