Migrate from Mintlify
Move an existing Mintlify project to Tangly without editing source files.
~ 1 min read
Migrate from Mintlify
Tangly renders Mintlify projects unmodified. Migration is mostly swapping the CLI and pointing $schema at Tangly’s schema.
-
Install Tangly
bash bun add -D tangly -
Run migrate
bash bun x tangly migrateWhat it does:
- If you have
docs.json(Mintlify modern): validates against Tangly’s schema, updates$schemato Tangly’s URL, surfaces a notice ifthemeisn’t a Tangly theme. Thethemefield itself is not auto-rewritten — pick one yourself before runningtangly dev. - If you have
mint.json(Mintlify legacy): full conversion todocs.json. Source is renamed tomint.json.bak. Use--keep-sourceto keep the original. - If you have both: prefers
docs.jsonand leavesmint.jsonalone.
No MDX files are touched in either case.
- If you have
-
Replace dev/build commands
In
package.json, swap Mintlify’s CLI for Tangly’s:json { "scripts": { "dev": "tangly dev", "build": "tangly build" } } -
Run dev
bash bun run devOpen
http://localhost:4321. Walk every page side-by-side withmintlify dev(different port) to spot any rendering gaps.
Side-by-side compare
If you want to confirm parity before committing:
# Terminal 1
mintlify dev --port 3050
# Terminal 2
tangly dev --port 4321Browse both at the same time.
What’s compatible
Flags
--root <dir> string path default: . Project root.
--yes boolean path Skip confirmation prompts.
--keep-source boolean path When migrating from mint.json, retain the original instead of renaming it to mint.json.bak.