hugopoi
/
cupper-hugo-theme
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs for blog post toc

This commit is contained in:
zwbetz-gh 2019-02-13 13:05:10 -06:00 committed by GitHub
parent 24137e96bb
commit ee6c0266e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -11,6 +11,7 @@ An accessibility-friendly Hugo theme, ported from the [original Cupper](https://
- [Updating](#updating) - [Updating](#updating)
- [Run example site](#run-example-site) - [Run example site](#run-example-site)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Disable toc for a blog post](#disable-toc-for-a-blog-post)
- [Shortcodes](#shortcodes) - [Shortcodes](#shortcodes)
- [Favicons](#favicons) - [Favicons](#favicons)
- [Credits](#credits) - [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`. 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 ## Shortcodes
See the [full list of supported shortcodes](https://cupper-hugo-theme.netlify.com/cupper-shortcodes/). See the [full list of supported shortcodes](https://cupper-hugo-theme.netlify.com/cupper-shortcodes/).