Quickstart

Install

Writedocs runs on Node.js 22.12 or newer. Install it once, globally:

npm install -g @writedocs/generator

writedocs is now a command you can run in any folder. Your docs folder doesn’t need a package.json of its own.

To try it without installing, put npx @writedocs/generator in front of any command instead of writedocs - for example npx @writedocs/generator dev.

Create a project

mkdir my-docs && cd my-docs
writedocs init

This writes writedocs.json, a home page (index.mdx) and docs/getting-started.mdx. To create the project in another folder, pass its path: writedocs init ./my-docs.

Coming from Mintlify? Run writedocs convert --mintlify in your project instead - see Migrating from Mintlify.

Preview it

writedocs dev

Run it in the folder writedocs.json is in. It opens the site in your browser (http://localhost:4321), and updates it as you edit pages and writedocs.json.

Check it

writedocs validate
writedocs broken-links

validate lists every problem in writedocs.json and the pages, with file and line; broken-links finds links that lead nowhere. Both work well as a CI step.

Publish

Push your changes. The site is built and published from there.