Skip to main content

​
YAML Front Matter

When enabled, the exporter prepends a YAML front matter block to every exported .md file. This is useful for static site generators (MkDocs, Docusaurus, Jekyll, Hugo), documentation pipelines, and Obsidian.

​
Enabling Front Matter

In the exporter panel, toggle “Include YAML front matter” to on. A preview of the front matter block appears in the live preview.

​
Built-in Fields

The following fields are available and individually toggleable: Toggle any field off to exclude it from the output.

​
Custom Fields

Add your own key-value pairs for downstream processing. Click ”+ Add custom field”, enter a key and a static value, and it will be included in every exported file. Example use cases:
  • status: draft — mark all exports as drafts in a CMS
  • product: backend-api — tag exports for a specific product
  • category: internal — classify content for a static site

​
Example Output

With all built-in fields enabled and two custom fields added:

​
Front Matter in Static Site Generators

Most static site generators read YAML front matter to build navigation, set page titles, and configure metadata. Common integrations:
  • MkDocs — uses title for nav labels
  • Docusaurus — reads title, description, and custom fields
  • Jekyll / Hugo — any YAML field becomes available as a template variable
  • Obsidian — displays front matter in the Properties panel