Installation

plasmoid is a single Rust binary. Until it is published to a registry, build it from the repository with a recent stable toolchain (edition 2024).

Build from source

plasmoid is distributed as source you build with Cargo. From the repository root:

cargo build --release

The binary lands at target/release/plasmoid. Put it on your PATH, or invoke it through Cargo while developing:

cargo run --release -- build --docs ./docs --site ./public

Verify it works

plasmoid --help
plasmoid build --help
plasmoid serve --help

You should see the two verbs plasmoid offers: build (render the whole site) and serve (local preview with optional live reload). Both are covered in the CLI reference.

Requirements

• A recent stable Rust toolchain.
• git on PATH is optional but recommended: plasmoid uses it to stamp each page’s last-updated date from commit history, falling back to file mtime when git isn’t available.

That’s all. plasmoid has no runtime, no database, and no service to keep running — it produces a directory of files.