3.0 KiB
Cupper
An accessibility-friendly Hugo theme, ported from the original Cupper project.
Table of contents
- Demo
- Minimum Hugo version
- Installation
- Updating
- Run example site
- Configuration
- Logo
- Favicons
- Shortcodes
- Syntax highlighting
- Disable toc for a blog post
- Getting help
- Credits
Demo
https://cupper-hugo-theme.netlify.com/
Minimum Hugo version
Hugo version 0.58.3 or higher is required. View the Hugo releases and download the binary for your OS.
Installation
From the root of your site:
git submodule add https://github.com/zwbetz-gh/cupper-hugo-theme.git themes/cupper-hugo-theme
Updating
From the root of your site:
git submodule update --remote --merge
Run example site
From the root of themes/cupper-hugo-theme/exampleSite:
hugo server --themesDir ../..
Configuration
Copy the config.toml or config.yaml from the exampleSite, then edit as desired.
Logo
Place your SVG logo at static/images/logo.svg. If you don't provide a logo, then the default theme logo will be used.
Favicons
Upload your image to RealFaviconGenerator then copy-paste the generated favicon files under static.
Shortcodes
See the full list of supported shortcodes.
Syntax highlighting
Syntax highlighting is provided by Prism. See this markdown code fences example.
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
---
Getting help
If you run into an issue that isn't answered by this documentation or the exampleSite, then visit the Hugo forum. The folks there are helpful and friendly. Before asking your question, be sure to read the requesting help guidelines. Feel free to tag me in your question, my forum username is @zwbetz.
Credits
Thank you to Heydon Pickering and The Paciello Group for creating the original Cupper project.