mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
3b2ab685d9
* docs: add platform migration guides * move migrations.mdx to migrations/index.mdx * add doc360 and fern guides * /goal loop * copy edit index * copy edit doc 360 * docusaurus copy edits * fern copy edit * gitbook copy edit * copy edit go-live * resolve TODOs * manual copy edit * readme copy edit * Fix GitBook terminology, Document360 export steps, and revert banner examples - migration/gitbook.mdx: GitBook renamed spaces to sections. Their current docs use "section" exclusively across the Git Sync, content-structure, content-configuration, and reusable-content pages. Update terminology throughout, add a note about the older name, correct the Git Sync setup steps to match the real flow (Set up next to Git Sync in the section header, then pick a provider), and expand the direction warning with the version-history rollback. Add a Vale.Terms toggle so .gitbook.yaml and .gitbook/ paths do not trip the GitBook capitalization rule. - migration/document360.mdx: fix "Document 360" typo and align the export procedure with Document360's documented dialog order, including the format selection, the Include media files checkbox, and downloading from Recent files. - Revert components/banner.mdx and its es/fr/zh copies. The /migration link there is a placeholder inside an example, and translated content is handled by the translation pipeline. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Rename migration hub page to avoid duplicating its group name The group is already called "Migrate to Mintlify", so the root page title repeated it in the sidebar. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Address migration guide nits: Fern paths, scraper page command, placeholders - migration/fern.mdx: correct the source-content paths against Fern's documented project structure. Pages live in fern/docs/pages/ and assets in fern/docs/assets/. Add the previously missing fern/docs/snippets/, fern/docs/changelog/, and fern/styles.css, note that only the fern and changelog folder names are reserved, and map Fern snippets to Mintlify snippets in the component table. - migration/index.mdx: document the scraper's page command, which was only documented in the deleted migration.mdx. Covered once here rather than repeated in each scraper-supported platform guide. Also update the GitBook card to say section instead of space. - migration/readme.mdx: replace https://project.readme.io with https://your-project.readme.io. The former is a real login-gated project. - migration/docusaurus.mdx: remove trailing whitespace. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * remove go live checklist * add launch your site snippet * update index * 💅 * 💅 --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
50 lines
2.5 KiB
Plaintext
50 lines
2.5 KiB
Plaintext
---
|
|
title: "Migration overview"
|
|
sidebarTitle: "Overview"
|
|
description: "Choose a migration path for moving existing documentation from Docusaurus, ReadMe, GitBook, Fern, Document360, or another platform to Mintlify."
|
|
keywords: ["migration", "Docusaurus", "ReadMe", "GitBook", "Fern", "Document360", "import"]
|
|
---
|
|
|
|
Move your existing documentation to Mintlify with an automated scraper, an export from your current platform, or a manual migration. The best path depends on whether your site is public, whether you can access its source files, and which platform-specific features you use.
|
|
|
|
<Card title="Docusaurus" href="/migration/docusaurus">
|
|
Scrape a public site, or migrate from source to preserve private pages, versioned docs, localized content, and custom React components.
|
|
</Card>
|
|
<Card title="ReadMe" href="/migration/readme">
|
|
Export project files to preserve private content and OpenAPI files, or scrape a public site for a faster starting point.
|
|
</Card>
|
|
<Card title="GitBook" href="/migration/gitbook">
|
|
Export each section with Git Sync for the most complete migration, or scrape a public site.
|
|
</Card>
|
|
<Card title="Fern" href="/migration/fern">
|
|
Migrate MDX, assets, API specifications, and `docs.yml` configuration from the source repository.
|
|
</Card>
|
|
<Card title="Document360" href="/migration/document360">
|
|
Export every workspace and language as a project ZIP, including articles, categories, and media files.
|
|
</Card>
|
|
<Card title="Other platforms" href="/migration/manual">
|
|
Follow the manual workflow for another platform or a project with mixed content sources.
|
|
</Card>
|
|
|
|
## Scrape individual pages
|
|
|
|
The Docusaurus, ReadMe, and GitBook guides use the scraper's `section` command, which converts every page it can reach from the URL you give it. To convert a single page instead, use the `page` command from your migration directory.
|
|
|
|
```bash
|
|
npx @mintlify/scraping@latest page https://docs.example.com/getting-started
|
|
```
|
|
|
|
Use `page` to check how the scraper converts your content before a full run, or to fill in individual pages that a `section` run missed. For a large site, narrow a `section` run with `--filter` rather than scraping everything at once.
|
|
|
|
## Generate a site from a repository
|
|
|
|
Mintlify can generate a complete documentation site for any GitHub repository, whether it already contains documentation or just code.
|
|
|
|
Replace `github` with `mintlify` in your repository URL.
|
|
|
|
```text
|
|
https://github.com/org/repo -> https://mintlify.com/org/repo
|
|
```
|
|
|
|
Browse [generated documentation sites](https://www.mintlify.com/wiki) to see more examples.
|