Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
How to

Try a theme

Preview every preset, palette, and color mode on this page, then copy the config.

Updated
Read as Markdown

Pick a shape, a palette, and a mode. This page restyles itself as you choose. Scroll down to see how each option styles the sample content, then copy the config into docs.config.yaml.

Every preset works with every palette, in light or dark mode.

Browse themes and palettes
Preset Shape Default palette
shoal Flat page with a ruled sidebar and square-cornered controls. kelp
reef Rounded panels on a tinted page, with pill navigation and controls. coral
ledger Technical manual with an inked masthead, monospace headings, and numbered sections. ink
vice Night masthead with a sunset stripe, bold italic type, and neon rules. vice
Palette Colors
kelp Sea green on white.
coral Coral accent over cool blue-gray neutrals.
ink Black ink on warm paper with a vermilion accent.
harbor Navy ink, blue links, and a yellow callout rule.
amethyst Violet accents over lavender neutrals.
vice Flamingo pink and aqua by day, neon on night purple after dark.
docs.config.yaml
theme:
  preset: vice
  palette: harbor
  mode: system

The preview lasts until you leave the page or press Reset. It does not change the site for other readers. Your site's project CSS still applies on top of the preview.

Sample content

A guide page mixes prose, links, inline code, and components. Each preset styles them in its own way.

Tip: Try the vice shape in dark mode.

A table

Use this sample to inspect table headers, cell spacing, and inline values in the selected theme.

Setting Default Values
preset shoal shoal, reef, ledger, vice
palette Preset default Any built-in name, or a custom palette
mode light light, dark, system

A code block

docs.config.yaml
theme:
  preset: reef
  palette: amethyst
  mode: system

Tabs

Light

Readers always see the light set.

Dark

Readers always see the dark set.

System

The site follows each reader's system setting, with an optional toggle.

Add the previewer to a page

Place the component on its own line in any MDX page:

<ThemePreview />

The component takes no attributes. The build then publishes every preset and palette under /assets/themes/, so the previewer works on a static host. Sites that don't use the component don't publish those files.

Without JavaScript, and in the Markdown twin, the component shows the preset and palette tables and an example config.