yaakdoc

Static, themable, and LLM-friendly API documentation generated from Yaak exports.

npx yaakdoc          # dev server for the Yaak export in the current folder
npx yaakdoc build    # static site in dist/

Documentation · Quickstart · Live demo

This package contains:

• the CLI (dev, build, preview, init, eject): see the CLI reference;
• the Node API (build, createDevServer, preview, eject, init) and yaakdoc/static: see the Node API;
• the integrations that serve the docs from an existing app: the yaakdoc/vite plugin and yaakdocMiddleware. For Next.js, use @yaakdoc/next.

// vite.config.ts
import { defineConfig } from "vite";
import yaakdoc from "yaakdoc/vite";

export default defineConfig({
  plugins: [yaakdoc({ path: "/docs", export: "./yaak.json" })],
});

The config's JSON schema is published as yaakdoc/config.schema.json. See the configuration reference.