# yaakdoc

> Static, themable and LLM-friendly API documentation, generated from your Yaak workspace.

yaakdoc reads a Yaak export (`yaak.json`) and builds a documentation site with the CLI (`npx yaakdoc`), the Yaak plugin, or an integration for Next.js, Vite or Node. Every page below is Markdown; append `.md` to any docs URL for its Markdown version. The complete docs are in [llms-full.txt](https://yaakdoc.dev/llms-full.txt).

## Getting started

- [Introduction](https://yaakdoc.dev/docs.md): yaakdoc turns a Yaak workspace into a fast, themable and LLM-friendly API documentation site.
- [Quickstart](https://yaakdoc.dev/docs/quickstart.md): Turn a Yaak export into a documentation site with the yaakdoc CLI.
- [Yaak plugin](https://yaakdoc.dev/docs/yaak-plugin.md): Build the docs from inside Yaak, with a form for every option. No Node.js required with the default theme.
- [Project setup](https://yaakdoc.dev/docs/project-setup.md): Install yaakdoc in a project, add a config file and keep the export in version control.

## Guides

- [Custom pages](https://yaakdoc.dev/docs/guides/custom-pages.md): Write guides, a quickstart or a changelog in Markdown, next to the generated API reference.
- [Navigation](https://yaakdoc.dev/docs/guides/navigation.md): Arrange pages and the API reference into tabs, groups and nested groups.
- [Environments and variables](https://yaakdoc.dev/docs/guides/environments.md): Resolve variables in examples, let readers switch environments, and keep secrets out of the docs.
- [Example responses](https://yaakdoc.dev/docs/guides/example-responses.md): Document what a request returns, with tabs for each status code.
- [Branding](https://yaakdoc.dev/docs/guides/branding.md): Set the title, logo, colors, fonts, links, footer and custom CSS of your docs.
- [Search](https://yaakdoc.dev/docs/guides/search.md): A static search index of every page, folder and request, with a Cmd+K dialog.
- [LLM-friendly output](https://yaakdoc.dev/docs/guides/llms.md): llms.txt, llms-full.txt and a Markdown version of every page, so agents can read your docs.
- [Run in Yaak](https://yaakdoc.dev/docs/guides/run-in-yaak.md): Add a button that imports your API into Yaak, from a sanitized copy of the export.
- [Deploying](https://yaakdoc.dev/docs/guides/deploying.md): Host the static site on Vercel, Netlify, GitHub Pages, Cloudflare Pages or any static host.

## Integrations

- [Next.js](https://yaakdoc.dev/docs/integrations/nextjs.md): Serve the docs at a path of a Next.js app with @yaakdoc/next.
- [Vite](https://yaakdoc.dev/docs/integrations/vite.md): Serve the docs from a Vite-based app (Vite, React Router, SvelteKit, Astro, ...) with yaakdoc/vite.
- [Node middleware](https://yaakdoc.dev/docs/integrations/node-middleware.md): Serve the docs from Express, Connect, Fastify, Nitro or any server that takes Connect-style middleware.

## Theming

- [Using themes](https://yaakdoc.dev/docs/theming.md): Pick a theme by short name, npm package or local path, and pass it options.
- [Kiseki](https://yaakdoc.dev/docs/theming/kiseki.md): The default theme, built with Tailwind CSS v4 and shadcn/ui.
- [Ejecting](https://yaakdoc.dev/docs/theming/ejecting.md): Copy the current theme into your project and change anything.
- [Writing a theme](https://yaakdoc.dev/docs/theming/authoring.md): Build a theme from unstyled React components, data hooks, and overrides.
- [Islands](https://yaakdoc.dev/docs/theming/islands.md): Add interactivity to static pages with islands that hydrate on their own.
- [Publishing a theme](https://yaakdoc.dev/docs/theming/publishing.md): Share your theme on npm so others can use it.

## Reference

- [CLI](https://yaakdoc.dev/docs/reference/cli.md): Every yaakdoc command and flag.
- [Configuration](https://yaakdoc.dev/docs/reference/configuration.md): Every option of yaakdoc.config.json.
- [Node API](https://yaakdoc.dev/docs/reference/node-api.md): Build, serve and eject from code, and the building blocks behind the integrations.
- [Code examples](https://yaakdoc.dev/docs/reference/snippets.md): The built-in code example generators, and how to write your own.
- [Packages](https://yaakdoc.dev/docs/reference/packages.md): The npm packages that make up yaakdoc, and what each one is for.

## Project

- [Contributing](https://yaakdoc.dev/docs/contributing.md): How yaakdoc is built, and how to work on it.