Open-source
documentation, self-hosted.
Tangly turns a folder of Markdown into a fast, themed, deployable docs site. No proprietary backend, no monthly bill — just a static binary and your repo.
tangly dev What Tangly is
Tangly turns Markdown into a fast, themed, deployable docs site.
Already have Mintlify? tangly dev renders your project as-is.
One-line install via curl.
npm i -g tangly tangly init tangly build 38 components, no imports.
Drop a tag in MDX. Every theme ships every component. Render here uses
the real @tanglydocs/theme-ui package — not screenshots.
v0.1.0
May 2026npm i -g tangly
bun add -g tangly
curl tangly.dev/install.sh | sh
Child of <Tabs>. One panel.
-
Install
npm i -g tangly -
Init
tangly init -
Build
tangly build
Child of <Steps>. One step.
Why Tangly?
Free?
Mintlify compat?
bun add tanglynpm i tanglypnpm add tanglymy-docs
- docs.json
- intro.mdx
api/
- openapi.yaml
$ tangly init my-docs
q string path required id uuid curl api.tangly.dev/v1
-H "Auth: $TOKEN"{ "id": "d_47" }v0.1 new beta
Press Cmd+K
SSE stream Server-sent events
An MDX file is markdown plus JSX.
npm install tanglyyarn add tanglypnpm add tanglybun add tanglyThe rest is here.
Every feature you'd reach for. Each does what it says.
Cold start under 2s on a hundred pages. tangly dev boots fast and stays out of the way.
Static index built at tangly build. No Algolia key, no third-party request, no per-month cost.
Mark a page draft: true. Hidden in production, visible in tangly dev. Ship preview builds with --include-drafts.
Put a component into components/. Use it from MDX. Hot reloads. No registration.
// components/PriceTable.tsx export default function PriceTable({ tiers }) { return <table> ... </table> } // pricing.mdx <PriceTable tiers={tiers} />
Build with --base /docs/. All asset paths rewrite. Works behind Caddy, nginx, or a Cloudflare Worker.
tangly migrate reads mint.json and emits a Tangly-shaped docs.json. MDX stays untouched.
Outgrown the magic? tangly eject materializes the synthesized Astro project into your repo. astro.config.mjs is yours to edit. One-way, no Tangly required after.
A 14-line GitHub Actions workflow ships your docs to GitHub Pages on every push. Bun caches resolve in seconds. The Tangly monorepo deploys itself this way.
Six themes. Same Markdown.
Swap a one-line value in docs.json. Same content, new register. Each tile is a real Tangly site —
click through to examples.tangly.dev.
Mintlify-Mint inspired. Sidebar nav, on-page TOC, monospace headings.
Serif headings, cream surface, generous measure. For long-form writing.
No sidebar. Single-column reading mode. Headings as the only navigation.
Narrow column, large body type, drop caps. Reads like a manual.
Vercel/Linear register. Ink ground, thin rules, dense type scale.
Three sections, three pages, no opinions. The fastest way to start typing.
Point at an OpenAPI spec. Get a real API reference.
Drop a 3.0 or 3.1 spec into docs.json. Tangly generates browseable endpoint pages with schemas, examples,
and a try-it panel — no third-party explorer required.
openapi: 3.1.0 info: title: Search Stream version: 2026.05.01 paths: /v1/search-stream: get: summary: Stream search results parameters: - in: query name: q required: true schema: type: string responses: '200': content: text/event-stream: ...
Stream search results
Returns a server-sent event stream of search results as they're resolved.
Search query. May include wildcards.
Maximum results. Capped at 250.
Static output. Ship anywhere.
tangly build emits a
folder. Drop it on any host that serves files. No runtime, no Node
process.
