Editorial

Editorial is an official yaakdoc theme for APIs that are mostly prose: guides, concepts and long descriptions. It's built with Tailwind CSS v4 and Radix UI, and uses Source Serif 4, Inter and JetBrains Mono, bundled locally, so it makes no external requests.

See it live.

npm i -D @yaakdoc/theme-editorial

{
  "theme": "editorial"
}

• A masthead with the site's name and description, and the navigation tabs as its sections.
• Serif type in a comfortable reading column, with a drop cap on the overview's introduction.
• A table of contents next to the content on wide screens, and in a drawer on smaller ones.
• Code examples and example responses as numbered figures with captions.
• Parameters and headers as side notes in the margin on very wide screens, and inline below the request otherwise.
• Light ("paper") and dark ("night reading") mode, following the system setting until the reader picks one.

OptionsCopy Anchor Link

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

CustomizingCopy Anchor Link

• Colors and fonts. Use branding.colors and branding.fonts. branding.fonts.sans replaces the serif reading font, and branding.fonts.mono the code font. Labels and buttons stay in Inter.
• Small CSS tweaks. Use branding.customCss.
• Everything else. Eject the theme. It has the same structure as Kiseki.