Markdown in. Beautiful docs out.
Self-hosted, open-source documentation framework.

website · docs · changelog · examples · npm

Features

• Fast dev server. Astro 6 + Vite. HMR under 250ms. Cold start under 2s on a hundred pages.
• Host anywhere. Static builds you drop on Vercel, Cloudflare, Netlify, AWS, GitHub Pages, S3, nginx. No runtime.
• Built on Astro. Builds an Astro site you can eject.
• Drop-in Mintlify compat. Point Tangly at an existing docs.json + MDX project. No source edits.
• Five themes. tang, pith, pip, readable, geist. See live demos.
• 38 MDX components built in: Cards, Tabs, Steps, Accordions, ParamFields, CodeGroups, Mermaid, KaTeX, OpenAPI try-it. No imports.
• Built for AI agents. Every page is also served as raw Markdown (.md URL or Accept: text/markdown). About 10× token reduction. /llms.txt and /llms-full.txt ship by default.
• OpenAPI 3.0 / 3.1. Point at a spec, get browseable endpoint pages with try-it.
• Static output. tangly build emits a folder. No runtime.
• Pagefind search built in. Instant, ⌘K, no Algolia key.
• Custom themes. Build them using components from @tanglydocs/theme-ui.
• One-line migration from Mintlify. tangly migrate reads mint.json, emits a Tangly-shaped docs.json. MDX stays untouched.

Install

npm i -g tangly

Or run once without installing:

npx tangly init
bunx tangly init

Then:

tangly init my-docs
cd my-docs
tangly dev

Curl one-liner (alternative)

# Linux / macOS
curl -fsSL https://tangly.dev/install.sh | bash

# Windows (PowerShell)
iwr -useb https://tangly.dev/install.ps1 | iex

Full install paths in packages/tangly/README.md.

Quick links

• Documentation: guides, schema reference, CLI reference
• Website
• Theme demos: every theme rendering a real project
• Mintlify migration guide
• Deploy guide

Agent skills

Tangly ships two Agent skills under skills/:

• tangly: use Tangly: init, verify, structure docs, port from Mintlify, deploy.
• tech-documentation: write good technical docs (Diátaxis-grounded).

npx skills add tanglydocs/tangly -g

Repo

Path	What
packages/tangly	the tangly CLI + manifest + Vite plugin
packages/schema	@tanglydocs/schema: Zod + JSON Schema
packages/theme-ui	shared MDX components
packages/theme-{tang,pith,pip,readable,geist}	the five themes
packages/template-*	tangly init templates
packages/website	source for tangly.dev
docs/	source for docs.tangly.dev (rendered by Tangly itself)
examples/demo-*	per-theme corpora powering examples.tangly.dev
tests/parity/	Mintlify parity tests
install.sh, install.ps1	curl-installer scripts

Develop

bun install
bun run --parallel format:check lint typecheck
bun run dev:docs            # serve docs/ at :4322

Smoke-test the published tarball against a clean install:

bun run scripts/smoke-tarball.ts

License

MIT © 2026 Nik Cubrilovic