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

Reorder headings

Browse Source
This commit is contained in:
zwbetz-gh 2019-02-14 09:02:30 -06:00 committed by GitHub
parent 288d73df03
commit 17bd36f5a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -11,10 +11,11 @@ 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) - [Logo](#logo)
- [Favicons](#favicons)
- [Syntax highlighting](#syntax-highlighting) - [Syntax highlighting](#syntax-highlighting)
- [Shortcodes](#shortcodes) - [Shortcodes](#shortcodes)
- [Favicons](#favicons) - [Disable toc for a blog post](#disable-toc-for-a-blog-post)
- [Credits](#credits) - [Credits](#credits)
## Demo ## Demo
@ -49,8 +50,22 @@ hugo server --themesDir ../..
Copy the `config.toml` from the [`exampleSite`](https://github.com/zwbetz-gh/cupper-hugo-theme/tree/master/exampleSite), then edit as desired. Copy the `config.toml` from the [`exampleSite`](https://github.com/zwbetz-gh/cupper-hugo-theme/tree/master/exampleSite), then edit as desired.
## Logo
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`.
## Favicons
Upload your image to [RealFaviconGenerator](https://realfavicongenerator.net/) then copy-paste the generated favicon files under `static`.
## Syntax highlighting
Syntax highlighting is provided by [Prism](https://prismjs.com/). See the [full list of supported languages](https://prismjs.com/#languages-list).
## Shortcodes
See the [full list of supported shortcodes](https://cupper-hugo-theme.netlify.com/cupper-shortcodes/).
## Disable toc for a blog post ## 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: 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:
@ -62,18 +77,6 @@ toc: false
--- ---
``` ```
## Syntax highlighting
Syntax highlighting is provided by [Prism](https://prismjs.com/). See the [full list of supported languages](https://prismjs.com/#languages-list).
## Shortcodes
See the [full list of supported shortcodes](https://cupper-hugo-theme.netlify.com/cupper-shortcodes/).
## Favicons
Upload your image to [RealFaviconGenerator](https://realfavicongenerator.net/) then copy-paste the generated favicon files under `static`.
## Credits ## Credits
Thank you to [Heydon Pickering](http://www.heydonworks.com) and [The Paciello Group](https://www.paciellogroup.com/) for creating the original Cupper project. Thank you to [Heydon Pickering](http://www.heydonworks.com) and [The Paciello Group](https://www.paciellogroup.com/) for creating the original Cupper project.