@yaakdoc/theme-editorial

Editorial is a yaakdoc theme for APIs that are mostly prose: serif type in a comfortable reading column, a masthead with the navigation tabs as its sections, a table of contents, numbered figures for examples and responses, and side notes for parameters on wide screens. Light mode is paper, dark mode a night-reading mode.

It's built with Tailwind CSS v4 and Radix UI, and uses Source Serif 4, Inter and JetBrains Mono, bundled locally, so there are no external requests. See it live.

Usage

npm i -D @yaakdoc/theme-editorial

{
  "theme": "editorial",
  "themeOptions": {
    "measure": "68ch",
    "dropCap": true,
    "navOpenDepth": 2
  }
}

| Option | Default | Description | | --- | --- | --- | | measure | "68ch" | Width of the reading column (any CSS length). | | dropCap | true | Start the overview's introduction with a drop cap. | | navOpenDepth | 2 | Folder levels expanded in the contents by default. Folders containing the current page or section always open. |

branding.fonts.sans replaces the serif reading font. See the Editorial docs for more, and Ejecting to change anything.