Settings

Configure your project via docs.json.

Settings

Tangly reads a single docs.json at your project root.

Minimal

json

{
  "$schema": "https://tangly.dev/schema/docs.json",
  "name": "My Docs",
  "theme": "tang",
  "colors": { "primary": "#0ea5e9" },
  "navigation": {
    "groups": [{ "group": "Get Started", "pages": ["introduction"] }]
  }
}

That’s enough to render.

Common fields

name string path required

Display name. Shown in the title bar, sitemap, and llms.txt.

description string path

Site description. Used in meta tags and llms.txt.

theme string path default: tang

Theme to render with. Built-ins: tang, pith, geist, pip, readable. Mintlify aliases (mint, maple, palm, willow, linden, almond, aspen, luma, sequoia) all map to tang.

colors.primary string path

Hex accent color. Drives links, focus rings, and theme accents.

favicon string path

Path to a favicon, e.g. /images/favicon.svg.

navigation object path required

Defines how pages are grouped. Either groups (flat) or tabs (top-level tabs containing groups). See Navigation.

Validate

bash

tangly check

Reports schema violations, missing pages, and broken internal links.

Live docs

Full reference: tangly.dev/reference/schema/docs-json.

Edit this page