83 lines
2.2 KiB
Markdown
83 lines
2.2 KiB
Markdown
# Cupper
|
|
|
|
[](https://app.netlify.com/sites/cupper-hugo-theme/deploys)
|
|
|
|
An accessibility-friendly Hugo theme, ported from the [original Cupper](https://github.com/ThePacielloGroup/cupper) project.
|
|
|
|
## Table of contents
|
|
|
|
- [Demo](#demo)
|
|
- [Installation](#installation)
|
|
- [Updating](#updating)
|
|
- [Run example site](#run-example-site)
|
|
- [Configuration](#configuration)
|
|
- [Logo](#logo)
|
|
- [Favicons](#favicons)
|
|
- [Syntax highlighting](#syntax-highlighting)
|
|
- [Shortcodes](#shortcodes)
|
|
- [Disable toc for a blog post](#disable-toc-for-a-blog-post)
|
|
- [Credits](#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`](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`.
|
|
|
|
## 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 this [markdown code fences example](https://cupper-hugo-theme.netlify.com/cupper-shortcodes/#syntax-highlighting).
|
|
|
|
## Shortcodes
|
|
|
|
See the [full list of supported shortcodes](https://cupper-hugo-theme.netlify.com/cupper-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](http://www.heydonworks.com) and [The Paciello Group](https://www.paciellogroup.com/) for creating the original Cupper project.
|