|
@@ -11,10 +11,11 @@ An accessibility-friendly Hugo theme, ported from the [original Cupper](https://
|
|
|
- [Updating](#updating)
|
|
|
- [Run example site](#run-example-site)
|
|
|
- [Configuration](#configuration)
|
|
|
-- [Disable toc for a blog post](#disable-toc-for-a-blog-post)
|
|
|
+- [Logo](#logo)
|
|
|
+- [Favicons](#favicons)
|
|
|
- [Syntax highlighting](#syntax-highlighting)
|
|
|
- [Shortcodes](#shortcodes)
|
|
|
-- [Favicons](#favicons)
|
|
|
+- [Disable toc for a blog post](#disable-toc-for-a-blog-post)
|
|
|
- [Credits](#credits)
|
|
|
|
|
|
## Demo
|
|
@@ -49,18 +50,13 @@ hugo server --themesDir ../..
|
|
|
|
|
|
Copy the `config.toml` from the [`exampleSite`](https://github.com/zwbetz-gh/cupper-hugo-theme/tree/master/exampleSite), then edit as desired.
|
|
|
|
|
|
-Replace `static/images/logo.svg` with your logo. Keep the filename as `logo.svg`.
|
|
|
+## Logo
|
|
|
|
|
|
-## Disable toc for a blog post
|
|
|
+Replace `static/images/logo.svg` with your logo. Keep the filename as `logo.svg`.
|
|
|
|
|
|
-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:
|
|
|
+## Favicons
|
|
|
|
|
|
-```
|
|
|
----
|
|
|
-title: "My page with a few headings"
|
|
|
-toc: false
|
|
|
----
|
|
|
-```
|
|
|
+Upload your image to [RealFaviconGenerator](https://realfavicongenerator.net/) then copy-paste the generated favicon files under `static`.
|
|
|
|
|
|
## Syntax highlighting
|
|
|
|
|
@@ -70,9 +66,16 @@ Syntax highlighting is provided by [Prism](https://prismjs.com/). See the [full
|
|
|
|
|
|
See the [full list of supported shortcodes](https://cupper-hugo-theme.netlify.com/cupper-shortcodes/).
|
|
|
|
|
|
-## Favicons
|
|
|
+## Disable toc for a blog post
|
|
|
|
|
|
-Upload your image to [RealFaviconGenerator](https://realfavicongenerator.net/) then copy-paste the generated favicon files under `static`.
|
|
|
+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
|
|
|
|