cupper-hugo-theme/README.md

58 lines
1.2 KiB
Markdown
Raw Normal View History

2019-02-04 21:55:40 +01:00
# Cupper
2019-02-13 03:22:28 +01:00
[![Netlify Status](https://api.netlify.com/api/v1/badges/bc8c4e51-37ee-419d-ad4f-b378010ee546/deploy-status)](https://app.netlify.com/sites/cupper-hugo-theme/deploys)
2019-02-13 06:13:39 +01:00
An accessibility-friendly Hugo theme, ported from the [original Cupper](https://github.com/ThePacielloGroup/cupper) project.
2019-02-01 01:19:20 +01:00
## Table of contents
2017-11-02 16:37:06 +01:00
2019-02-13 06:13:39 +01:00
TODO generate
2019-02-01 01:19:20 +01:00
## Demo
2019-02-13 06:13:39 +01:00
https://cupper-hugo-theme.netlify.com/
2019-02-01 01:19:20 +01:00
## Installation
From the root of your site:
```
2019-02-01 01:38:14 +01:00
git submodule add https://github.com/zwbetz-gh/cupper-hugo-theme.git themes/cupper-hugo-theme
2019-02-01 01:19:20 +01:00
```
## Updating
From the root of your site:
```
git submodule update --remote --merge
```
## Run example site
2019-02-01 01:38:14 +01:00
From the root of `themes/cupper-hugo-theme/exampleSite`:
2019-02-01 01:19:20 +01:00
```
hugo server --themesDir ../..
```
## Configuration
2019-02-01 01:38:14 +01:00
Copy the `config.toml` or `config.yaml` TODO from the `exampleSite` TODO, then edit as desired.
2019-02-01 01:19:20 +01:00
2019-02-13 06:13:39 +01:00
## Favicons
2019-02-01 01:19:20 +01:00
2019-02-13 06:13:39 +01:00
TODO link RealFaviconGenerator and give steps
2019-02-01 01:19:20 +01:00
2019-02-13 06:13:39 +01:00
## Shortcodes
2019-02-01 01:38:14 +01:00
2019-02-13 06:52:29 +01:00
TODO link to demo post
2019-02-01 01:38:14 +01:00
2019-02-01 01:19:20 +01:00
## Credits
2019-02-13 03:33:05 +01:00
Thank you to:
2019-02-01 01:19:20 +01:00
2019-02-13 16:21:25 +01:00
- [Heydon Pickering](http://www.heydonworks.com) and [The Paciello Group
](https://www.paciellogroup.com/) for creating the original Cupper project
2019-02-01 01:19:20 +01:00
- [Netlify](https://www.netlify.com/) for deploys