What is plasmoid?

plasmoid turns a folder of Markdown into a fast, accessible, multilingual, versioned static documentation site — then gets out of the way. There is no Node, no runtime framework, no client-side router. You build the site once and serve the resulting directory from plain nginx (or any static host).

It exists to avoid two bad options for documentation:

• Heavy JS docs frameworks (Docusaurus-class) that pull thousands of transitive packages — a large, unaudited supply-chain surface for what is, in the end, just text.
• Single-page apps that ship a bundle and render in the browser, so content only appears after JavaScript loads (blank → flash → content). That is the slow-docs anti-pattern.

plasmoid pre-renders everything. First paint is immediate, pages are readable with JavaScript disabled, and the output is deterministic and offline-buildable.

The shape of it

# Build the whole site
plasmoid build --docs ./docs --site ./public

# Preview locally with live reload
plasmoid serve --docs ./docs --watch

You write Markdown; plasmoid owns the rendering, navigation, theming, search, versioning, and the output tree. It reads your content and never mutates it.

Where to go next

• New here? Start with the Quickstart.
• Writing docs? See Authoring Docs.
• Curious how it works? Read How It Works.
• Ready to ship? Jump to Deploying.