Questa guida ti aiuta a trasferire la documentazione esistente su Mintlify. Scegli la migrazione automatica per le piattaforme supportate oppure quella manuale per avere il pieno controllo del processo.

​
Scegli il tuo percorso di migrazione

Migrazione automatica

Se stai passando da Docusaurus, ReadMe o GitBook, usa i nostri strumenti per automatizzare la migrazione.

Migrazione manuale

Se stai passando da un’altra piattaforma, segui la nostra guida per migrare i contenuti.
Migra la tua documentazione usando il pacchetto @mintlify/scraping. Il pacchetto estrae i tuoi contenuti e li converte per usare i Componenti (Mintlify).

​
Piattaforme supportate

Docusaurus

ReadMe

GitBook (beta)

Se la tua documentazione è ospitata su un’altra piattaforma, consulta i passaggi per la migrazione manuale.

​
Installazione dello scraper

Installa il pacchetto @mintlify/scraping per iniziare.
npm install @mintlify/scraping@latest -g

​
Effettuare lo scraping di pagine e sezioni

Lo strumento di migrazione rileva automaticamente la tua piattaforma di documentazione e converte i contenuti. I file preparati vengono salvati in locale in ./docs per impostazione predefinita.Per siti di documentazione di grandi dimensioni, migra sezioni più piccole per volta invece dell’intero sito in una sola volta.Migrare intere sezioni:
mintlify-scrape sezione https://your-docs-site.com/docs
Migrare singole pagine:
mintlify-scrape page https://il-tuo-sito-di-documentazione.com/docs/getting-started
Migrare le specifiche OpenAPI:
mintlify-scrape openapi-file [nomeFileOpenAPI]

​
Aggiungi contenuti predefiniti al tuo progetto Mintlify

Dopo aver effettuato lo scraping della tua piattaforma di documentazione esistente, sei pronto a creare la tua documentazione su Mintlify.Verifica che tutte le tue pagine siano state migrate, quindi aggiungi questi file al repository della documentazione creato durante l’onboarding. Di solito è un repository GitHub.

​
Checklist post-migrazione

Dopo aver completato la migrazione (automatica o manuale), consigliamo di verificare:
  • Tutte le pagine vengono visualizzate correttamente
  • La navigazione funziona come previsto
  • I link interni puntano correttamente
  • Immagini e risorse si caricano correttamente
  • I blocchi di codice mostrano l’evidenziazione della sintassi corretta
  • La ricerca funziona
  • Il deployment è configurato
  • Il dominio personalizzato è configurato