Skip to content

Latest commit

 

History

History
203 lines (128 loc) · 5.61 KB

README.md

File metadata and controls

203 lines (128 loc) · 5.61 KB
Raw

Paperesque

A lightweight Hugo theme with a couple of neat tricks.

You can see it in action on capnfabs.net.

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.

Install

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/capnfabs/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 ✨

git submodules

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

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

Select the theme in your config.toml

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

theme = "paperesque"

Using Features

Homepage

You've got a bunch of options for the homepage:

1. A custom list of links.

This was the only thing supported until Dec 2022-ish.

Add something like this to your site's config.toml:

[[params.menu]]
  name = "blog"
  url = "posts/"

[[params.menu]]
  name = "tags"
  url = "tags/"

[[params.menu]]
  name = "about"
  url = "about/"

[[params.menu]]
  name = "contact"
  url = "contact/"

2. Markdown content

You can create a /content/_index.md and the content of that page will render as the homepage.

3. A section

You can create a /content/_index.md and in the frontmatter add a display_section key. The name of that section will be used to render a list of content.

4. A section + custom content in a sidebar.

Do the same as for option 3 ('a section'), but also include markdown content in that file. The markdown content will render on the left as a sidebar, and the list of section items will render in the main panel.

Links in the top-right corner

These are config driven! Add this to your config.toml (for example):

[[params.topmenu]]
  name = "about"
  url = "about/"

[[params.topmenu]]
  name = "contact"
  url = "contact/"

[[params.topmenu]]
  name = "rss"
  url = "posts/index.xml"

Removing original images after resizing

The fitfigure shortcode is exactly the same as the figure shortcode, but it automatically resizes your images to fit the container, and provides different resolutions for different DPIs (1x, 2x).

Whenever you use this shortcode, the theme makes a mental note of the resource you specified.

Now, you need to do some configuration if you want the originals to be removed from the output.

First, add this to your site's config.toml:

[outputs]
page = ["HTML", "droplist"]

Now, as part of your build process, run:

./themes/paperesque/buildscripts/drop-resources.py [hugo-output-directory]

(the Hugo output directory is usually ./public).

That's it! Resized resources will be removed.

This is off by default because it peppers your build output with .droplist files, and if you're not expecting them, it's going to be an unpleasant surprise.

Visual differentiation for drafts

This one's on, and can't be switched off. Drafts have an orange stripey background everywhere. You can't miss them.

Footnotes turn into margin notes

This is on by default.

You can switch it off site-wide by adding disableMarginNotes = true to your params in your config.toml, i.e.

[params]
disableMarginNotes = true

Alternatively, you can turn it off per-page by adding the disableMarginNotes = true to your front-matter for the page.

Make pages only visible / accessible by URL

You can prevent a page from being publicly visible (included in lists etc) by adding the following to your front-matter:

sitemap:
    disable: true
params:
    mostlyHidden: true
  • Note that sitemap.disable is only available since Hugo 0.125.0, so ensure you're building with that if you're relying upon this feature.

Testing against the example site

You can build the example site with this theme with:

cd exampleSite
hugo serve --themesDir=../..

Hacking / Modifying the JS

The javascript in use (assets/js/main.js) is built from the ./js/ directory. Here are instructions for how to modify the JS:

Set up

First, you need to install the yarn package manager.

Then, run:

yarn install

to install the required dependencies.

Dev builds

Run:

npx parcel watch

Simple as that!

Production builds (i.e. before you commit code / deploy code)

npx parcel build --no-source-maps

Other resources