Tangly v0.2 ships richer code blocks, page chrome, and more — see what's new

Themes overview

Tangly ships five themes. One token swap, no component changes. Pick one or roll your own.

Themes

Tangly ships five themes out of the box. They share the same component shell (@tanglydocs/theme-ui) — what differs is colors, typography, layout dimensions, and chrome.

The five built-ins

Live demos

Every theme renders a real Tangly project at examples.tangly.dev. Each is a different docs.json + MDX corpus; the only thing that changes between them is the theme field.

The source for each demo lives in examples/demo-<theme>/ in the Tangly repo — clone, edit, tangly dev to play.

Switch themes

One field in docs.json:

json
{ "theme": "tang" }

Reload the dev server (tangly dev) to see it. No other changes required — components are theme-agnostic.

Picking one

If your docs are…Pick
A general OSS / dev-tool siteTang
A handbook, knowledge base, or design-led docsPith
A 4–5 page README replacementPip
A book, essay collection, or long manuscriptReadable
A modern dev-tool with grayscale + restraintGeist

How themes work

Each theme is a separate package: @tanglydocs/theme-tang, @tanglydocs/theme-pith, @tanglydocs/theme-pip, @tanglydocs/theme-readable, @tanglydocs/theme-geist.

Inside each package: a single theme.css file with the token table (colors, fonts, layout dimensions). Components are shared — they consume the tokens at render.

docs.json (theme: "pith")
   ↓
resolveTheme()
   ↓
@tanglydocs/theme-pith → theme.css with pith's tokens
   ↓
@tanglydocs/theme-ui   → renders Layout/TopNav/Sidebar/etc using those tokens

This means switching themes is risk-free. Authoring stays the same. No content edits. Just swap the field, rebuild.

Customization paths

Three knobs, in order of effort:

  1. Override colors via colors in docs.json. Five tokens. See Colors.
  2. Override fonts via fonts in docs.json. Heading and body. See Fonts & styling.
  3. Override CSS variables in theme/styles/theme.css. Drop the file at your project root; Tangly concatenates after the active theme. Full control.

For deep custom layouts, shadow the components or eject.

See Customizing themes for the full picture.

Mintlify aliases

Existing Mintlify projects often have theme: "mint" or one of: maple, palm, willow, linden, almond, aspen, luma, sequoia. All resolve to tang. See Aliases for why.

Schema reference

For the full theme: field definition, see Schema → Themes.

↑↓ navigate open esc close