plasmoid
EN

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

---
template: home
title: plasmoid
tagline: Markdown in → fast, versioned static HTML out.
cta: { text: "Get started", href: "getting-started/quickstart" }
secondary: { text: "Reference", href: "reference/configuration" }
features:
  - { title: "No SPA", body: "Real HTML at real paths; JS is optional." }
  - { title: "Minimal deps", body: "A handful of audited crates." }
  - { title: "Versioned", body: "Old releases archived, never dropped." }
---

# Introduction

Prose rendered below the hero — the same Markdown you'd write anywhere.

Hero fields

FieldMeaning
titleLarge hero title (falls back to the first # H1 if omitted).
taglineOne-line description under the title.
ctaPrimary button: { text, href }.
secondarySecondary link: { text, href }.
featuresA list of { title, body } cards.

cta/secondary href values are slug paths relative to the locale root — no .md, no NN- prefixes:

cta: { text: "Get started", href: "getting-started/quickstart" }

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.

Last updated: 2026-06-22