The documentation is a work in progress. You might want to look at the markdown files on GitHub.

The theme supports four menus:

  1. primary - primary navigation on the top
  2. home - navigation on the homepage
  3. footer - navigation in the footer
  4. social - icons in the footer

Entries can be customized, including pre and post, but also params.class (to add a custom css class) and params.icon to add an icon from the asset folder.

Lists

Lists can have two styles (see lists):

  1. default - displays subpages in an extended paginated format.
  2. listSimple - displays subpages below the site’s describtion without pagination.

Search is handled client site via FlexSearch, using a JSON file created at build time. To exclude a page from the search, set excludeFromSearch to true in the page’s frontmatter.

SEO

For all pages, SEO meta tags are automatically added (Schema, OpenGraph, Twitter Cards).

You can add a featured image by adding an image with cover or thumbnail in its name to a page’s bundle. If no featured image is specified, one is created automatically by writing the page’s title on a base image.

To use a different base image, overwrite assets/social/card-base.png.

Math

Support for mathematical equations via MathJax. x = {-b \pm \sqrt{b^2-4ac} \over 2a} becomes: \(x = {-b \pm \sqrt{b^2-4ac} \over 2a}\). Note that math needs to be set to true in the page’s frontmatter.

Netlify Features

Headers can be configured within /layouts/index.headers. See Netlify.

Redirect rules can be appended to /layouts/index.redirects. See Netlify.

Hugo’s Aliases have been disabled within hugo.yml with disableAliases = true, and instead are handled by Netlify Redirects. This is handled automatically and one should continue to add aliases as described in the Hugo documentation.

Type to search or press esc to cancel.