Writedocs

A static site generator for documentation: a writedocs.json config + a folder of MDX/Markdown in, a fully static site out. Built on Astro, in the spirit of Docusaurus/Mintlify.

Quickstart

npm install -g @writedocs/generator

cd my-docs   # any folder containing writedocs.json + docs/
writedocs dev
writedocs validate
writedocs build

Commands

| Command | What it does | |---|---| | writedocs init [dir] | Scaffolds a writedocs.json and a starter docs/ folder. | | writedocs dev [dir] | Starts a local dev server with hot reload. | | writedocs validate [dir] | Checks <dir>/writedocs.json against the schema. Exits 0 when it is valid and 1 when it is not, so it can gate a CI job; prints one line per problem, in the same words the build uses. Runs entirely locally — no key, no network. Configuration only: it does not resolve OpenAPI specs, and it does not check that the pages named in navigation exist. |

[dir] defaults to the current directory in every command.

The npm package is @writedocs/generator; the CLI command it installs is still writedocs (see the bin field in package.json).

npx @writedocs/generator init/dev/build still works too, for a one-off run with no install at all.