Blog

Document settings#

Document settings (or also called front matter) provide a way to enrich documents with metadata used to generate your documentation site.

They are defined at the top of the .mdx file, use YAML and can be used to customize your pages by passing this data to your theme.

markdown
1
---
2
name: My Document
3
---
4
5
# Other stuff
6
7
Minim magna in veniam Lorem adipisicing deserunt.

Document settings Dokz uses are:

  • name The name of your document, used for the link in the sidebar

Previous
Writing MDX
Next
Preview React Components
Document settings