Blueprint

Blueprint is an official yaakdoc theme that draws your API docs as technical drawings. It's built with Tailwind CSS v4 and Radix UI, and uses IBM Plex Sans and Mono, bundled locally, so it makes no external requests.

See it live.

npm i -D @yaakdoc/theme-blueprint

{
  "theme": "blueprint"
}

• A header drawn as a title block, with the navigation tabs, the environment and the sheet number: the page's position among the pages in navigation order, with the API reference counting as one sheet.
• The navigation as a numbered sheet index.
• Requests drawn as schematics. Path parameters in the URL get numbered callouts, with a legend below.
• Parameters, headers and variables as numbered parts lists, and code examples and responses in detail frames.
• A drafting grid behind the content. Dark mode is a blueprint (white lines on blue), light mode a whiteprint (blue lines on white).

OptionsCopy Anchor Link

{
  "theme": "blueprint",
  "themeOptions": {
    "grid": true,
    "sidebarWidth": "18rem",
    "navOpenDepth": 2
  }
}

CustomizingCopy Anchor Link

• Colors and fonts. Use branding.colors and branding.fonts. branding.colors.background replaces the blueprint blue, and the lines follow the foreground color.
• Small CSS tweaks. Use branding.customCss.
• Everything else. Eject the theme. It has the same structure as Kiseki.