Paperesque

A unique Hugo theme with a couple of neat tricks.

You can see it in action on the demo site.

Here's what makes it special:

• Has a shortcode for resizing images to fit the page, and tools for removing originals from the output
• Footnotes turn into margin notes when there's enough space.
• Tools for editing and controlling publication:
  • Visual differentiation for drafts
  • The ability to "mostly hide" pages so that they're only accessible by knowing the URL.
• Support for ABC notation music sheets and playback via abcjs
• Fun animations and transitions
• Gruvbox, the best theme with dynamic light/dark modes
• Copy button for markdown code blocks
• Support for iconify web components
• Scroll progress bar
• Custom callout alerts with animations
• Critical CSS support for avoiding pesky flash of unstyled content

Table of Contents

• 1. Install
  • 1.1. git subtree (easiest!)
  • 1.2. git submodules
  • 1.3. Select the theme in your config.toml
• 2. Using Features
• Credits
  • Libraries

1. Install

1.1. git subtree (easiest!)

Copy the files into your repo using git subtree (this is way easier to use than submodules; here's an explainer):

git subtree add --prefix themes/paperesque https://github.com/intothebeans/paperesque mainline --squash

This will add a commit to your repo with everything ready to go. You'll probably want to modify parts of this theme for your own usage! Subtree makes that easy, because you've just copied the code into your repo ✨

1.2. git submodules

If you're sure you want to use git submodules:

git submodule add -b mainline https://github.com/intothebeans/paperesque themes/paperesque

1.3. Select the theme in your config.toml

Add / Modify the theme field in your config.toml for your hugo site:

theme = "paperesque"

2. Using Features

Checkout the documentation at https://paperesque.pages.dev/docs/ or the docs folder.

Credits

This is a fork of the original Paperesque theme by @capnfabs.

Libraries

• ABCJS by Paul Rosen (MIT)
• Iconify by Iconify (MIT)
• critical by Addy Osmani (Apache 2.0)