Quickstart
Scaffold a docs site, run it locally, and publish it — in about five minutes.
Quickstart
By the end of this page you will have a documentation site running on your machine, have made your first edit, and know both ways to put it live.
You need Node.js 22 or newer, and an npm registry token for
@fiskil/docs (your Fiskil contact provides one).
Scaffold a site
npx fiskil init my-docs
cd my-docs
npm installfiskil init creates a complete, working site: a starter docs.json, an
example content tree, and the handful of framework files the engine expects.
The scaffold pins @fiskil/docs to the CLI's own version, so the template
and engine never drift apart.
Run it locally
npx fiskil devThis validates your docs.json, fetches any remote OpenAPI specs, and
starts a dev server at http://localhost:3000 with hot reload. Leave it
running.
Make your first edit
Open content/docs/ and change any page — the browser updates as you save.
Every .mdx file needs one thing, a title:
---
title: My first page
description: Shows up in search, meta tags, and sidebar tooltips.
---
# My first page
Regular markdown, plus [components](/learn/writing/components) when you want them.Where the file sits decides its URL: content/docs/payments/guides/refunds.mdx
is served at /payments/guides/refunds. The structure guide
covers the whole mapping.
Make it yours
Open docs.json and set your name and brand color — the entire theme
follows one value:
{
"name": "Acme",
"theme": { "colors": { "primary": "#0033A9" } }
}Everything else in the file is optional and documented field-by-field in the docs.json reference.
Publish
Two ways, and you can use both:
From your terminal — one command uploads your source and the platform builds and hosts it:
FISKIL_DOCS_TOKEN=fdp_... FISKIL_DOCS_PLATFORM_URL=https://... npx fiskil publishFrom GitHub — connect your repository once in the Fiskil console, and every push to your main branch deploys automatically; pull requests get preview links. This is the recommended setup for teams — nobody runs anything.
Either way your site is live at https://your-site.docs.fiskil.app, and you
can attach your own domain whenever you're ready.