diff --git a/README.md b/README.md index db077fb..314a8cc 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ An accessibility-friendly Hugo theme, ported from the [original Cupper](https:// - [Updating](#updating) - [Run example site](#run-example-site) - [Configuration](#configuration) +- [Disable toc for a blog post](#disable-toc-for-a-blog-post) - [Shortcodes](#shortcodes) - [Favicons](#favicons) - [Credits](#credits) @@ -49,6 +50,17 @@ Copy the `config.toml` from the [`exampleSite`](https://github.com/zwbetz-gh/cup Replace `static/images/logo.svg` with your logo. Keep the filename as `logo.svg`. +## Disable toc for a blog post + +Blog posts that have two or more subheadings (`

`s) automatically get a table of contents. To disable this set `toc` to `false`. For example: + +``` +--- +title: "My page with a few headings" +toc: false +--- +``` + ## Shortcodes See the [full list of supported shortcodes](https://cupper-hugo-theme.netlify.com/cupper-shortcodes/).