cupper-hugo-theme/README.md

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
• Syntax highlighting
• Shortcodes
• Disable toc for a blog post
• Credits

Demo

https://cupper-hugo-theme.netlify.com/

Minimum Hugo version

Hugo version 0.48 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 from the exampleSite, then edit as desired.

Logo

Replace static/images/logo.svg with your logo. Keep the filename as logo.svg.

Favicons

Upload your image to RealFaviconGenerator then copy-paste the generated favicon files under static.

Syntax highlighting

Syntax highlighting is provided by Prism. See this markdown code fences example.

Shortcodes

See the full list of supported shortcodes.

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
---

Credits

Thank you to Heydon Pickering and The Paciello Group for creating the original Cupper project.