Codex Documentation Manager
Configuration
Frontmatter

Frontmatter in documents

Documents should have a block at the beginning of the file which can configure them. Frontmatter is written in YAML.

The general format is:

---
title: My Page Title
# other fields
---
...

Fields

title
optional
String

This is used as the page title and is rendered into the top header.

subtitle
optional
String

A subtitle that is rendered smaller and above the main header on the page.

tags
optional
Array(String)

A list of tags that will be rendered in the side bar of the page, below the table of contents.


Default value:[]
menu_position
optional
Array(String)

Sets the position of the page in the navigation menu. A larger number will be farther down and a smaller number will be closer to the top.

If not specified the value is 0 and negative numbers can be used to prioritize groups above default ones.

Pages which have the same position (including pages with unspecified positions) will be sorted alphabetically.


Default value:0
menu_exclude
optional
bool

If true the page will not be displayed in the navigation menu.


Default value:false
json_schema
optional
String

Specify a JSON Schema file to automatically generate field definitions and object example based on the details in the schema file.

See JSON Schema components.


Default value:false
Generated by Codex