Quickstart
Make this site yours in five minutes
Run the site locally
From the project folder:
npm install
npx fiskil devOpen http://localhost:3000. Pages reload as you edit.
Rename and re-brand
Open docs.json and change two values:
{
"name": "Acme",
"theme": { "colors": { "primary": "#0EA5E9" } }
}Refresh the browser — the header, buttons, links, and dark mode all pick up your brand color instantly. No rebuild needed.
Add your first page
Create content/docs/example/guides/hello.mdx:
---
title: Hello
description: My first page
---
It works!Then add "hello" to the pages list in
content/docs/example/guides/meta.json so it appears in the sidebar.
Point it at your API (optional)
Drop your OpenAPI file into public/openapi/ and reference it in
docs.json under openapi.variants. Every endpoint gets a generated page
with schemas, code samples, and a live playground — see the
API reference for what that looks like.
That's the whole workflow
Markdown for content, docs.json for everything else. Run
npx fiskil validate any time to check your settings file — the site
refuses to build with a broken config, so mistakes never reach readers.