Handbook Development
Development environment and processes for maintaining the handbook
Handbook frontmatter
Information on what frontmatter entries are available and how to use them.
Handbook Markdown Guide
Read through our Markdown Style Guide!
Partials

Hugo partials are bits of reusable content. They’re primarily used for parts of theme files, other HTML (such as layout) files, and within shortcodes.

Partials may exist in the theme for use on all content sites, or in a specific repository, such as the handbook. Many partials are duplicated, sometimes with minor edits, in the handbook projects.

Partials are easy to make, so many have been created without documentation. If you encounter a partial that is not listed, please look for the merge request that introduced it to ask the creator to document it, or ask in the #handbook Slack channel.

Running the Handbook in Docker
Instructions for running the Handbook projects in Docker
Running the Handbook Locally
Instructions for running the Handbook projects locally
Shortcodes

Shortcodes are pre-defined ways to display content in Markdown files. If something looks somewhat like a shortcode, but starts with “partial”, then it’s a partial.

The shortcodes are listed alphabetically after the shortcode explanatory sections.

Shortcodes are easy to make, so many have been created without documentation. If you encounter a shortcode that is not listed, please look for the merge request that introduced it to ask the creator to document it, or ask in the #handbook Slack channel.

Last modified October 3, 2023: Update 3 files (3e7f87bf)