Quickstart

This walks you from an empty folder to a served site in a few minutes.

1. Create a docs folder

plasmoid reads a docs tree whose root holds a plasmoid.toml config and one directory per locale:

docs/
  plasmoid.toml
  en/
    index.md

A minimal plasmoid.toml is just a title:

[site]
title = "My Project"

Everything else has a sensible default. The full schema is in the configuration reference.

2. Write a home page

en/index.md with the home template becomes the site’s landing page:

---
template: home
title: My Project
tagline: A short, punchy description.
cta: { text: "Read the docs", href: "getting-started/intro" }
---

# Welcome

Some introductory prose rendered below the hero.

See The home page for every hero field.

3. Add a page

Create en/getting-started/intro.md:

---
title: Introduction
---

# Introduction

Your first real page. Folders become sidebar sections automatically.

How folders and files turn into navigation is covered in Navigation.

4. Preview it

plasmoid serve --docs ./docs --watch

This builds the site, serves it on http://localhost:8080, and rebuilds on every change. Open the URL and you’ll see your home page, the sidebar, dark-mode toggle, and search.

5. Build for production

plasmoid build --docs ./docs --site ./public

./public now contains the complete static site. Ship that directory anywhere — the Deploying section shows the nginx recipe.

Next: build the same site step by step in Your first build.