Sfoglia il codice sorgente

Docs for blog post toc

zwbetz-gh 6 anni fa
parent
commit
ee6c0266e4
1 ha cambiato i file con 12 aggiunte e 0 eliminazioni
  1. 12 0
      README.md

+ 12 - 0
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 (`<h2>`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/).