@yaakdoc/theme-blueprint
v0.1.0
Published
Blueprint - a technical-drawing yaakdoc theme with a title block, a sheet index and requests drawn as schematics.
Downloads
332
Maintainers
Readme
@yaakdoc/theme-blueprint
Blueprint is a yaakdoc theme that draws your API docs as technical drawings: a title block with the environment and the sheet number, the navigation as a numbered sheet index, requests as schematics with callouts on their path parameters, and parameters as numbered parts lists, on a drafting grid. Dark mode is a blueprint (white lines on blue), light mode a whiteprint (blue lines on white).
It's built with Tailwind CSS v4 and Radix UI, and uses IBM Plex Sans and Mono, bundled locally, so there are no external requests. See it live.
Usage
npm i -D @yaakdoc/theme-blueprint{
"theme": "blueprint",
"themeOptions": {
"grid": true,
"sidebarWidth": "18rem",
"navOpenDepth": 2
}
}| Option | Default | Description |
| --- | --- | --- |
| grid | true | Draw the drafting grid behind the content. |
| sidebarWidth | "18rem" | Any CSS length. |
| navOpenDepth | 2 | Folder levels expanded in the navigation by default. Folders containing the current page or section always open. |
See the Blueprint docs for more, and Ejecting to change anything.
