Este guia ajuda você a migrar sua documentação existente para o Mintlify. Escolha a migração automatizada para plataformas compatíveis ou a migração manual para ter controle total sobre o processo.

​
Escolha seu caminho de migração

Migração automatizada

Se você está migrando do Docusaurus, ReadMe ou GitBook, use nossas ferramentas para automatizar a migração.

Migração manual

Se você está migrando de outra plataforma, siga nosso guia para migrar seu conteúdo.
Migre sua documentação usando o pacote @mintlify/scraping. O pacote faz o scraping do seu conteúdo e o converte para usar os Componentes (Mintlify).

​
Plataformas compatíveis

Docusaurus

ReadMe

GitBook (beta)

Se a sua documentação estiver hospedada em outra plataforma, consulte as etapas de migração manual.

​
Instalando o scraper

Instale o pacote @mintlify/scraping para começar.
npm install @mintlify/scraping@latest -g

​
Coletando (scraping) páginas e seções

A ferramenta de migração detecta automaticamente sua plataforma de documentação e converte o seu conteúdo. Os arquivos gerados são armazenados localmente em ./docs por padrão.Para sites de documentação grandes, migre pequenas seções por vez, em vez de todo o site de uma só vez.Migrar seções completas:
mintlify-scrape seção https://your-docs-site.com/docs
Migrar páginas individuais:
mintlify-scrape page https://seu-site-de-docs.com/docs/getting-started
Migrar especificações do OpenAPI:
mintlify-scrape arquivo-openapi [openApiFilename]

​
Adicione conteúdo pronto ao seu projeto Mintlify

Depois de fazer o scraping da sua plataforma de documentação atual, você está pronto para construir sua documentação no Mintlify.Confirme que todas as suas páginas foram migradas e, em seguida, adicione esses arquivos ao repositório de documentação que você criou durante o processo de onboarding. Geralmente, é um repositório no GitHub.

​
Lista de verificação pós-migração

Após concluir sua migração (automatizada ou manual), recomendamos verificar:
  • Todas as páginas são renderizadas
  • A navegação funciona como esperado
  • Os links internos são resolvidos corretamente
  • Imagens e recursos carregam corretamente
  • Blocos de código são exibidos com realce de sintaxe adequado
  • A funcionalidade de pesquisa funciona
  • A implantação está configurada
  • O domínio personalizado está configurado