PaperCSS

A Hugo theme made with PaperCSS, the less formal CSS framework.

Demo
Minimum Hugo version
Installation
Updating
Run example site
Configuration
Favicons
Shortcodes
Disable toc for a blog post
Disable summary for a blog post
Getting help
Credits

Demo

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

Minimum Hugo version

Hugo version 0.81.0 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/papercss-hugo-theme.git themes/papercss-hugo-theme

Updating

From the root of your site:

git submodule update --remote --merge

Run example site

From the root of themes/papercss-hugo-theme/exampleSite:

hugo server --themesDir ../..

Configuration

Copy config.yaml from the exampleSite, then edit as desired.

Favicons

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

Shortcodes

See the full list of supported 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
---

Disable summary for a blog post

The homepage blog post listing shows a summary for each post. To disable this for an individual post set show_summary to false. For example:

---
title: "My page with some stellar content"
show_summary: false
---

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 Rhyne Vlaservich for creating PaperCSS, and all the contributors.

3.3 KiB Raw Permalink Blame History