hugopoi
/
cupper-hugo-theme
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
415 Commits 1 Branch 0 Tags 12 MiB
HTML 51%
CSS 33%
JavaScript 15.5%
Shell 0.5%
Go to file
zwbetz-gh 1929b7a9c5 update hugo version to 0.83.1 2021-05-19 21:06:01 -05:00
.github/ISSUE_TEMPLATE Update issue templates 2019-02-13 09:19:10 -06:00
archetypes Remove unused archetype 2019-02-18 15:39:38 -06:00
assets remove darkThemeAsDefault 2020-11-24 20:52:10 -06:00
data Reorganize 2019-01-31 18:19:20 -06:00
exampleSite new site param: logoAlt 2021-05-16 01:44:41 -05:00
i18n i18n for search 2020-07-10 13:59:32 -05:00
images Add theme screenshots 2019-02-15 11:24:23 -06:00
layouts meta description 2021-05-19 20:59:38 -05:00
static Update Miriam Libre Bold; source: google-webfonts-helper (hebrew+latin+latin-ext); fixes #40 (#43) 2020-08-22 13:47:17 -05:00
.gitignore Ignore resources dir 2019-02-25 20:20:23 -06:00
LICENSE Reorganize 2019-01-31 18:19:20 -06:00
README.md support custom css and js files 2020-11-16 20:32:11 -06:00
local_git_config.sh script to setup local git config 2020-06-10 19:51:33 -05:00
netlify.toml update hugo version to 0.83.1 2021-05-19 21:06:01 -05:00
task_serve.sh config option to show theme switcher 2021-01-10 13:36:21 -06:00
theme.toml upgrade to hugo 0.60.1 2019-12-10 21:06:02 -06:00

README.md

Cupper

Netlify Status

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

Table of contents

Demo

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

Minimum Hugo version

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

Place your SVG logo at static/images/logo.svg. If you don't provide a logo, then the default theme logo will be used.

Favicons

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

Shortcodes

See the full list of supported shortcodes.

Syntax highlighting

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

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

Localization

The strings in the templates of this theme can be localized. Make a copy of <THEME_BASE_FOLDER>/i18n/en.yaml to <YOUR_SITE_FOLDER>/i18n/<YOUR_SITE_LANGUAGE>.yaml, and translate one by one, changing the translation field.

Here is a tutorial that goes more in depth about this.

Custom CSS and JS

You can provide an optional list of custom CSS files, which must be placed inside the static dir. These will load after the theme CSS loads. So, static/css/custom_01.css translates to css/custom_01.css.

You can provide an optional list of custom JS files, which must be placed inside the static dir. These will load after the theme JS loads. So, static/js/custom_01.js translates to js/custom_01.js.

See the example site config file for sample usage.

Getting help

If you run into an issue that isn't answered by this documentation or the exampleSite, then visit the Hugo forum. The folks there are helpful and friendly. Before asking your question, be sure to read the requesting help guidelines.

Credits

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