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

website · docs · changelog · examples · npm · GitHub

Features

• Self-hosted and open source. A static site you own, hosted anywhere: Vercel, Cloudflare, Netlify, AWS, GitHub Pages, S3, nginx. No proprietary backend, no monthly bill.
• Drop-in Mintlify compatible. Point Tangly at an existing docs.json + MDX project and it renders unchanged. tangly migrate converts a mint.json in one command. No source edits.
• Auto-generated API docs. Point at an OpenAPI 3.0 / 3.1 spec and get browseable endpoint pages with an interactive try-it panel. Redoc, Scalar, and Stoplight viewers too.
• 38 MDX components, no imports. Cards, Tabs, Steps, Accordions, callouts, ParamFields, CodeGroups, and more. Every theme ships every one.
• Code, math, and diagrams. Shiki syntax highlighting with line highlights, diffs, focus, and titles. Mermaid diagrams. KaTeX math. Multi-language CodeGroups and package-manager tabs.
• 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.
• Five themes, or your own. tang, pith, pip, readable, geist via one theme field. Build custom themes from @tanglydocs/theme-ui. See live demos.
• Search built in. Pagefind, instant, ⌘K. No Algolia key, no third-party request.
• Social cards, generated. Every page gets a branded 1200×630 Open Graph image built from its title, theme, and your colors. Links unfurl instead of rendering blank. Per-environment URLs keep PR previews out of search.
• Custom components. Drop an .astro component into components/ and use it from MDX. Hot-reloads, no registration.
• Drafts. Mark a page draft: true. Hidden in production, visible in tangly dev, shippable with --include-drafts.
• Readable config errors. tangly check reports problems key-by-key with line numbers, plain-English reasons, and did-you-mean fixes.
• Fast dev, ejectable. Astro 6 + Vite under the hood: HMR under 250ms, cold start under 2s on a hundred pages. tangly eject to a raw Astro project whenever you outgrow the magic.

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
• Changelog: release notes, newest first
• 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