Configuration

Everything is optional. A config file is yaakdoc.config.json (.jsonc, .ts and .js work too) in the project directory. See Project setup.

{
  "$schema": "./node_modules/yaakdoc/config.schema.json",
  "branding": {
    "title": "Acme API"
  }
}

The $schema gives you autocomplete and validation in your editor. The schema is published with the yaakdoc package, and on unpkg.

Top-level optionsCopy Anchor Link

brandingCopy Anchor Link

See Branding.

branding.colorsCopy Anchor Link

branding.fontsCopy Anchor Link

branding.logoCopy Anchor Link

A path or URL, or an object:

navigationCopy Anchor Link

See Navigation.

A NavigationItem is a page path (relative to pagesDir, without the extension), a NavigationGroup, or { "api": true }. A tab has tab, icon, pages, groups and api. A NavigationGroup has:

llmsCopy Anchor Link

See LLM-friendly output.

variablesCopy Anchor Link

See Environments and variables.

filterCopy Anchor Link

Glob patterns over request and folder slugs. See Leaving requests out.

runInYaakCopy Anchor Link

true, false or an object. See Run in Yaak.

serverCopy Anchor Link

Options of the dev server and preview.

headCopy Anchor Link

Extra tags injected into every page's <head>. See Extra head tags.