yaakdoc

Quickstart

Turn a Yaak export into a documentation site with the yaakdoc CLI.

You need Node.js 20.19 or later. Prefer to stay in Yaak? Use the Yaak plugin instead.

Export your workspace

In Yaak, open Settings (the cog in the top right corner) → Export Data, select your workspace, and save the export as yaak.json in an empty folder.

Start the dev server

In the same folder, run:

npx yaakdoc

Open http://localhost:4000. The page reloads whenever you save a new export, so you can keep editing requests and descriptions in Yaak and watch the docs update.

Build the static site

npx yaakdoc build

The site is written to dist/. It's plain HTML, CSS and a little JavaScript, ready for any static host. See Deploying.

Write good docs in Yaak

yaakdoc documents what's in your workspace, so the best docs start in Yaak:

  • Descriptions are Markdown. Add descriptions to the workspace, folders and requests. The workspace description becomes the overview page.
  • Folders become sections. Requests are grouped and sorted the way they are in Yaak.
  • Use variables. URLs like ${[ base_url ]}/products are resolved for the selected environment, so readers see real, copyable URLs. Secrets stay out. See Environments and variables.
  • Document responses. Add response:200 code blocks to a request's description. See Example responses.

Next steps

Set up a project

Install yaakdoc locally and add a config file with editor autocomplete.

Brand it

Title, logo, colors, fonts, links and footer.

Add pages

Guides, a quickstart or a changelog in Markdown.

Deploy

Vercel, Netlify, GitHub Pages, Cloudflare Pages and more.

Introduction

yaakdoc turns a Yaak workspace into a fast, themable and LLM-friendly API documentation site.

Yaak plugin

Build the docs from inside Yaak, with a form for every option. No Node.js required with the default theme.

On this page

Export your workspaceStart the dev serverBuild the static siteWrite good docs in YaakNext steps