Scaffold a documentation site powered by
@inkform/framework — pick a
theme, get a deployable Next.js project. Like npx shadcn, but for docs.
npx @inkform/cli@latest init my-docs- Asks where to create your project (or takes a directory argument). If that
folder already exists and isn't empty, it moves the current contents into
existing-contents/(and tells you), so nothing is overwritten. - Asks which theme you want — Aurora, Fern, Cedar, Mono, Base, or Galley.
- Downloads that theme as a standalone Next.js app.
- Optionally wires up your OpenAPI spec (path or URL) so the API Reference is generated from it. API docs are OpenAPI-first; everything else is MDX.
- Prints the next steps and points you at the project's deploy guide.
npx @inkform/cli@latest init [directory] [options]| Option | Description |
|---|---|
-t, --theme <name> |
aurora | fern | cedar | mono | base | galley |
-o, --openapi <src> |
path or URL to an OpenAPI spec for the API Reference |
--from <dir> |
scaffold from a local templates directory (development) |
-y, --yes |
accept defaults, skip optional prompts |
-h, --help |
show help |
# interactive
npx @inkform/cli@latest init
# pick everything up front
npx @inkform/cli@latest init docs --theme mono
# generate the API Reference from your spec
npx @inkform/cli@latest init api-docs --theme fern --openapi https://example.com/openapi.jsonThen:
cd my-docs
npm install
npm run devOpen http://localhost:3000. Each scaffolded project ships a README with content and deployment guides (Vercel + AWS Amplify).
MIT.