The home page
A locale’s index.md is its landing page. Give it template: home and plasmoid
renders a hero — title, tagline, call-to-action buttons, and feature cards — above
your Markdown body.
Full example
- - -
Hero fields
| Field | Meaning |
|---|---|
title | Large hero title (falls back to the first # H1 if omitted). |
tagline | One-line description under the title. |
cta | Primary button: { text, href }. |
secondary | Secondary link: { text, href }. |
features | A list of { title, body } cards. |
Hero link hrefs
cta/secondary href values are slug paths relative to the locale root —
no .md, no NN- prefixes:
cta:
That resolves to /<version>/<locale>/getting-started/quickstart/. Use full URLs
(https://…) for external links and #anchor for in-page jumps.
If there’s no index.md
A locale without an index.md doesn’t get a hero — plasmoid redirects the locale
root to its first sidebar page instead, so / is never a dead end.
Prebuilt landings
If your project ships a bespoke, separately-built static landing (e.g. a marketing
page), point [landing] dir at it and plasmoid mounts it at / verbatim instead
of rendering a markdown home. plasmoid never compiles that landing — it only copies
the finished output. The precedence is covered in Deploying.