Migrating to Typemark
Bring your docs from Mintlify, GitBook, ReadMe or anywhere else. Import a GitHub repository, convert a folder with the CLI, or let your coding agent do the rest.
2026年11月19日更新2分で読めます
Typemark reads the files your current platform already keeps in Git and converts them. Your pages keep their content and their URLs, and the import tells you exactly what it couldn't carry over.
From Mintlify
docs.json or mint.json with MDX pages. Your pages work as they are.
From GitBook
A space synced to GitHub with Git Sync. Blocks become components.
From ReadMe
A project synced to GitHub, or an export. Folders become navigation.
From anywhere else
Docusaurus, MkDocs, Fern, Notion, a live site. Your coding agent converts it.
Three ways to migrate
| How | Best for | |
|---|---|---|
| Import from GitHub | Create a project, choose Import from GitHub and pick the repository. Typemark detects the platform and converts it. | Mintlify, GitBook and ReadMe sites in a GitHub repository |
| The CLI | typemark migrate converts the folder you're in, and typemark check finds what would break. | Sites that aren't on GitHub, or when you want to review the result before pushing |
| Your coding agent | typemark migrate --agent claude starts your coding agent with Typemark's migration guide. | Other platforms, and whatever the import leaves to you |
All three produce the same thing: a folder of .mdx pages and a typemark.json that describes your navigation.
What the import does
- Detects the platform. Typemark looks for
docs.jsonormint.json(Mintlify),.gitbook.yamlandSUMMARY.md(GitBook), or adocs/folder with_order.yamlfiles (ReadMe), at the root of the repository or up to two folders down. - Writes
typemark.json. Navigation, page order, name, colour, logo and redirects come from your old config. - Converts what needs converting. Mintlify pages need nothing. GitBook blocks such as
{% hint %}become Typemark components. ReadMe pages keep their MDX; files move to match ReadMe's URLs, and emoji callouts anddoc:links are converted. - Commits once. Everything lands in one commit you can review, revert or diff.
- Builds your site and shows an import summary on the project overview.
The import summary
The project overview shows what happened until you dismiss it: pages found, pages in navigation, pages your navigation lists that don't exist, pages that exist but aren't in navigation, the components and blocks your pages use, and every setting Typemark didn't import, with the reason.
Nothing is dropped silently. If something is on that list, it's either fixed by hand in a few minutes or a good job for your coding agent.
Go-live checklist
New projects start offline, so you can check the site before anyone sees it.
Read the import summary
Fix missing pages and add any page you want published to navigation.
Run typemark check
In a local copy,
typemark checkreports navigation entries without a page, MDX that won't compile and broken links between pages.Check your old URLs
Open a few of your most visited pages under the new site's address. Add a redirect for any path that changed.
Stop the old platform writing to your repository
Turn off GitBook's Git Sync or ReadMe's GitHub sync, so only Typemark and your team change the files from now on.
Go live and move your domain
Click Go live in Settings > Publishing, then point your custom domain at Typemark.