cupper-hugo-theme

Cupper

An accessibility-friendly Hugo theme, ported from the original Cupper project.

Table of contents

• Demo
• Installation
• Updating
• Run example site
• Configuration
• Disable toc for a blog post
• Shortcodes
• Favicons
• Credits

Demo

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

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.

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.

Favicons

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

Credits

Thank you to:

• Heydon Pickering and The Paciello Group for creating the original Cupper project
• Netlify for deploys