Frontmatter Reference
updated
Every .meldoc.md file starts with a YAML frontmatter block — a small section of metadata between --- delimiters at the very top of the file.
Example
Here’s what a complete frontmatter block looks like:
---
alias: my-document
title: My Document Title
parentAlias: parent-doc
order: 2
workflow: published
visibility: visible
exposure: inherit
---
Everything after the closing --- is your document’s Markdown content.
Field reference
| Field | Required | Default | Description |
|---|---|---|---|
title |
Yes | — | The display title of your document |
alias |
For publish | — | Unique identifier (kebab-case). Used in magic links and URLs |
parentAlias |
No | — | Alias of the parent document for nesting |
order |
No | 0 | Position among siblings. Lower numbers appear first |
workflow |
No | published |
draft or published. Drafts are only visible to editors |
visibility |
No | visible |
visible or hidden. Hidden docs exist but don’t appear in the sidebar |
exposure |
No | inherit |
Access level: inherit, private, unlisted, or public |
Alias best practices
Your alias is a stable identifier — it’s used in magic links, URLs, and the CLI. A few guidelines:
- Use kebab-case:
getting-started, notGetting Startedorgetting_started - Keep it short but descriptive:
api-authis better thanaorapi-authentication-guide-v2 - Never rename an alias casually — it will break any magic links pointing to it
Tip: Click Edit on this page to see the frontmatter for this very document. It’s a great way to see how it works in practice.