Pages & frontmatter
A page is a Markdown (.md) file. plasmoid renders standard CommonMark, plus a
small, optional YAML frontmatter block at the very top.
Frontmatter
Frontmatter is a ----fenced YAML block before the content:
Fields plasmoid understands on a normal page:
| Field | Purpose |
|---|---|
title | The page title (sidebar label, <title>, search). Highest-priority title source. |
template | Selects a non-default template. home turns a page into the hero landing. |
Unknown fields are ignored, so you can carry your own metadata without plasmoid
complaining. Frontmatter is entirely optional — a file with no --- block is
treated as pure Markdown.
Where the title comes from
When several sources could name a page, plasmoid resolves the title in this order:
- Frontmatter
title. - The first level-1 heading (
# ...) in the body. - The filename (de-slugified, numeric prefix stripped).
So a file 01-quickstart.md with a # Getting started fast heading and no
frontmatter is titled “Getting started fast”.
Links between pages
Write links to other docs as ordinary relative Markdown links to the .md file.
plasmoid rewrites them to clean output URLs at build time:
The .md suffix is dropped, numeric ordering prefixes are stripped, and the
anchor is preserved — producing /<version>/<locale>/reference/configuration/#themes.
Because you link to the real on-disk file, the same links also resolve in a plain
Markdown viewer. External links, anchors, mailto:, and image/asset links are
passed through untouched.
Headings and the table of contents
Level-2 and level-3 headings get stable id slugs and populate the per-page
“On this page” table of contents automatically. Code blocks are syntax-highlighted
at build time — see Theming.