Terminal
A monospace theme for CLI-first APIs, with a shell prompt, a file-tree sidebar and a tmux-style status line.
Terminal is an official yaakdoc theme for APIs whose users live in a terminal. It's built with Tailwind CSS v4 and Radix UI, and uses JetBrains Mono, bundled locally, so it makes no external requests.
npm i -D @yaakdoc/theme-terminal{
"theme": "terminal"
}- A shell prompt for the current page in the top bar, such as
acme-store-api:~/guides/authentication$. - The navigation drawn as a file tree, and a folder's contents as an
ls -llisting. - Code examples and example responses in tmux-style panes. Responses start with their status line, such as
HTTP/1.1 201 Created. - A status line at the bottom with the navigation tabs as tmux windows, the environment switcher and the color mode.
- Light ("paper") and dark ("phosphor") mode, following the system setting until the reader picks one.
Options
{
"theme": "terminal",
"themeOptions": {
"palette": "green",
"cursor": true,
"sidebarWidth": "19rem",
"navOpenDepth": 2
}
}| Option | Default | Description |
|---|---|---|
palette | "green" | Phosphor color for prompts, links and highlights: "green", "amber" or "mono". A branding.colors.primary takes precedence. |
cursor | true | Show a blinking cursor after the prompt. It doesn't blink when the reader prefers reduced motion. |
sidebarWidth | "19rem" | Any CSS length. |
navOpenDepth | 2 | Folder levels expanded in the navigation by default. Folders that contain the current page or section are always open. |
Keyboard
- / or Cmd+K / Ctrl+K opens search.
- [ and ] go to the previous and next page, in navigation order. They work on custom pages and the API reference overview, and not while you type in a field.
Customizing
- Colors and fonts. Use
branding.colorsandbranding.fonts. Terminal uses the monospace font everywhere, sobranding.fonts.monoreplaces JetBrains Mono. - Small CSS tweaks. Use
branding.customCss. - Everything else. Eject the theme. It has the same structure as Kiseki.