Themes

Pick a look for your docs. Every package on npm with the yaakdoc-theme keyword shows up here. Use one by setting its name as "theme" in your config.

Using themes Writing a theme Publishing

Sort by

5 themes

Kiseki

OfficialDefault

v0.6.0 · by József Sallai @jozsefsallai1.4K/month

The default theme. Tailwind CSS v4 and shadcn/ui, light and dark mode, a sticky code panel, search and tabs.

Docs Demo npm Source

Install Kiseki

@yaakdoc/theme-kiseki

Kiseki comes with yaakdoc and is the default theme, so there's nothing to install.
1
Select it (optional)
Set theme in your config:
yaakdoc.config.json
```
{
  "theme": "kiseki"
}
```

Editorial

Official

v0.1.0 · by József Sallai @jozsefsallai339/month

Docs that read like a magazine: serif type, a masthead, a comfortable reading column, numbered figures and side notes for parameters.

Demo npm Source

Install Editorial

@yaakdoc/theme-editorial

1
Install the package
In the folder with your yaakdoc config:
npm i -D @yaakdoc/theme-editorial
2
Use the theme
Set theme in your config:
yaakdoc.config.json
```
{
  "theme": "editorial"
}
```
Or try it without changing your config:
```
npx yaakdoc --theme editorial
```
Building from Yaak? The Yaak plugin installs themes from npm for you, so you only need step 2.

Terminal

Official

v0.1.0 · by József Sallai @jozsefsallai337/month

Monospace docs for CLI-first APIs: a shell prompt, a file-tree sidebar, tmux-style panes and keyboard navigation.

Demo npm Source

Install Terminal

@yaakdoc/theme-terminal

1
Install the package
In the folder with your yaakdoc config:
npm i -D @yaakdoc/theme-terminal
2
Use the theme
Set theme in your config:
yaakdoc.config.json
```
{
  "theme": "terminal"
}
```
Or try it without changing your config:
```
npx yaakdoc --theme terminal
```
Building from Yaak? The Yaak plugin installs themes from npm for you, so you only need step 2.

Blueprint

Official

v0.1.0 · by József Sallai @jozsefsallai325/month

API docs as technical drawings: a title block, a sheet index, numbered parts lists and requests drawn as schematics on a grid.

Demo npm Source

Install Blueprint

@yaakdoc/theme-blueprint

1
Install the package
In the folder with your yaakdoc config:
npm i -D @yaakdoc/theme-blueprint
2
Use the theme
Set theme in your config:
yaakdoc.config.json
```
{
  "theme": "blueprint"
}
```
Or try it without changing your config:
```
npx yaakdoc --theme blueprint
```
Building from Yaak? The Yaak plugin installs themes from npm for you, so you only need step 2.

Windows XP

v0.3.0 · by József Sallai @jozsefsallai503/month

Inspired by the Windows XP Luna visual style: Blue, Olive Green and Silver schemes, Royale Noir in dark mode, a task pane, tabs and search.

Demo npm Source

Install Windows XP

yaakdoc-theme-winxp

1
Install the package
In the folder with your yaakdoc config:
npm i -D yaakdoc-theme-winxp
2
Use the theme
Set theme in your config:
yaakdoc.config.json
```
{
  "theme": "winxp"
}
```
Or try it without changing your config:
```
npx yaakdoc --theme winxp
```
Building from Yaak? The Yaak plugin installs themes from npm for you, so you only need step 2.