Hyperbook Documentation

Page Configuration

A page is a markdown file. It consists of a frontmatter and a content.

The frontmatter gives Hyperbook some information to work with. The frontmatter is at the very top of the markdown file and is fenced by three ---.

name: The Name of a Page

# A Headline

And some content

Here are the properties you can set in the frontmatter:

nameName of the page used in the navigation
descriptionDescription of the page used for SEO
keywordsA list of keywords used for SEO
indexA number indicating the position in the menu in relation to pages on the same level
hideHides the page from the navigation
tocShow or hide a table of content for the page. This is on for pages and off for glossary entries by default
✎ GitHub© Copyright 2024 by OpenPatch.