NewBuild your docs right from Yaak with the plugin

Beautiful API docs, straight from your Yaak workspace

yaakdoc turns the requests, folders and environments you already have in Yaak into a fast, static documentation site that people and AI agents both love to read.

Get started Live demo

An API reference built with yaakdoc's default theme: navigation, a request with its parameters, and code examples with example responses.

Run it wherever your docs belong

Build from inside Yaak, from the command line, or serve the docs from the app you already have.

Step 1
Install
In Yaak, open Settings › Plugins and install @yaakdoc/yaakdoc.
Step 2
Configure
Choose "Build docs with yaakdoc..." in the workspace menu and fill in the form.
Step 3
Build
Pick a folder. The site is built inside Yaak, with no Node.js needed.

Yaak plugin docs

Everything an API reference needs, without writing it twice

Use Yaak to document your API, then use yaakdoc to share it with your users.

Switch environments, keep secrets secret

Readers pick between your environments, then the page updates the base URL, variables, and examples instantly.

Prerendered per environment, so it works on any static host
secure(...) values and secret-like variables are never inlined
Private environments stay private

Learn more

Code examples in multiple language

Every request gets ready-to-run examples, and the language a reader picks sticks across the page.

cURL, JavaScript, Python, Go, grpcurl and wscat
HTTP, gRPC and WebSocket requests
Easy API for adding your own languages
Example responses per status code, from your descriptions

Learn more

A POST request with its Python example, where the password stays a placeholder, and its example responses.

Made for agents too

Your docs are as easy for an AI assistant to read as they are for humans.

llms.txt, llms-full.txt, and a Markdown version of every page
Copy page or section as Markdown
Open in ChatGPT or Claude, with the page as context

Learn more

The page actions menu: Copy as Markdown, View as Markdown, Open in ChatGPT, and Open in Claude.

Search built in

Press Cmd+K and find any page, folder or endpoint. No search service is necessary - the search index is statically generated!

Guides and the API reference in one place
Keyboard navigation from start to finish

Learn more

Guides next to the reference

Don't limit yourself to API docs. Write a quickstart, guides or a changelog in Markdown, and arrange them with the API reference in tabs and groups.

Yaak variables work in pages, and follow the environment switcher
Relative links and images just work

Learn more

An authentication guide written in Markdown, in the Guides tab of the docs.

Static and fast

Prerendered HTML. Only small islands hydrate in the browser.

Super themable

Brand it with config, eject the theme, or build your own.

Run in Yaak

One click imports the API into Yaak, from a sanitized export.

Zero config

The title, description and environment come from Yaak.

One export in, a whole site out

Point yaakdoc at your Yaak export, add a few lines of config if you like, and get HTML for people and Markdown for machines.

Your workspace yaak.json, exported from Yaak or by the plugin

yaakdoc.config.json (optional)

{
  "$schema": "./node_modules/yaakdoc/config.schema.json",
  "pagesDir": "./docs",
  "environments": "public",
  "branding": {
    "title": "Acme Store API",
    "url": "https://docs.acme.dev",
    "colors": {
      "primary": "#0f766e"
    }
  },
  "runInYaak": true
}

Your site HTML pages, a search index, a sitemap, and for LLMs:

llms.txt

# Acme Store API

> Manage products, orders and customers of an Acme storefront.

## Guides › Getting started

- [Introduction](https://docs.acme.dev/index.md): Everything you need to build on the Acme Store API.
- [Quickstart](https://docs.acme.dev/quickstart.md): Make your first request in under a minute.

## Products

- [List products](https://docs.acme.dev/reference/products/list-products.md)
- [Get a product](https://docs.acme.dev/reference/products/get-a-product.md): Retrieve a single product by its id.

Make it look like yours

Start with Kiseki, our default theme, then customize it with config or eject it and make your own, fully custom theme.

Kiseki

Default

The default theme. Tailwind CSS v4 and shadcn/ui, light and dark mode, a sticky code panel, search and tabs.

"theme": "kiseki"

Docs Demo

Build your own

A theme is a manifest plus React components. Unstyled building blocks, data hooks and an override system do the heavy lifting, and islands keep pages light. Publish it as yaakdoc-theme-* and anyone can use it by name.

Writing a theme Publishing

Your API docs are one command away

Free and open source under the MIT license. Bring a Yaak export and try it now.

npx yaakdocRead the quickstart