61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
# Cupper Hugo Theme
|
|
|
|
An accessibility-friendly Hugo theme, ported from the original [Cupper](https://github.com/ThePacielloGroup/cupper) project.
|
|
|
|
## Table of contents
|
|
|
|
TODO
|
|
|
|
## Demo
|
|
|
|
Dev demo, immediate updates: TODO
|
|
|
|
Hugo Themes demo, weekly-ish updates: TODO
|
|
|
|
## Installation
|
|
|
|
From the root of your site:
|
|
|
|
```
|
|
git submodule add https://github.com/zwbetz-gh/cupper-hugo-theme.git themes/cupper
|
|
```
|
|
|
|
## Updating
|
|
|
|
From the root of your site:
|
|
|
|
```
|
|
git submodule update --remote --merge
|
|
```
|
|
|
|
## Run example site
|
|
|
|
From the root of `themes/cupper/exampleSite`:
|
|
|
|
```
|
|
hugo server --themesDir ../..
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Copy the `config.toml` or `config.yaml` from the `exampleSite` TODO, then edit as desired.
|
|
|
|
## Typography
|
|
|
|
TODO
|
|
|
|
## Favicons
|
|
|
|
TODO link RealFaviconGenerator and give steps
|
|
|
|
## Credits
|
|
|
|
TODO
|
|
|
|
- Cupper and Heydon Pickering http://www.heydonworks.com
|
|
- [Netlify](https://www.netlify.com/) for deploys
|
|
- [Visual Studio Code](https://code.visualstudio.com/) for text editing
|
|
- [Fedora](https://getfedora.org/), [Xfce](https://www.xfce.org/), and [VirtualBox](https://www.virtualbox.org/) for development environment
|
|
- [gh-md-toc](https://github.com/ekalinin/github-markdown-toc) for table of contents generation
|
|
- [befunky](https://www.befunky.com/) for screenshot editing
|