Dieser Leitfaden unterstützt Sie dabei, Ihre bestehende Dokumentation zu Mintlify zu migrieren. Wählen Sie die automatische Migration für unterstützte Plattformen oder die manuelle Migration für vollständige Kontrolle über den Prozess.

​
Wählen Sie Ihren Migrationspfad

Automatisierte Migration

Wenn Sie von Docusaurus, ReadMe oder GitBook wechseln, nutzen Sie unsere Tools, um die Migration zu automatisieren.

Manuelle Migration

Wenn Sie von einer anderen Plattform kommen, folgen Sie unserer Anleitung, um Ihre Inhalte zu migrieren.
Migrieren Sie Ihre Dokumentation mit dem @mintlify/scraping-Paket. Das Paket crawlt Ihre Inhalte und konvertiert sie zur Verwendung der Mintlify-Komponenten.

​
Unterstützte Plattformen

Docusaurus

ReadMe

GitBook (Beta)

Wenn Ihre Dokumentation auf einer anderen Plattform gehostet wird, lesen Sie die manuellen Migrationsschritte.

​
Scraper installieren

Installieren Sie das Paket @mintlify/scraping, um zu beginnen.
npm install @mintlify/scraping@latest -g

​
Seiten und Abschnitte scrapen

Das Migrations-Tool erkennt Ihre Dokumentationsplattform automatisch und konvertiert Ihre Inhalte. Die vorbereiteten Dateien werden standardmäßig lokal in ./docs gespeichert.Bei großen Dokumentationsseiten migrieren Sie kleinere Abschnitte schrittweise, statt die gesamte Seite auf einmal zu migrieren.Komplette Abschnitte migrieren:
mintlify-scrape section https://your-docs-site.com/docs
Einzelne Seiten migrieren:
mintlify-scrape page https://your-docs-site.com/docs/getting-started
OpenAPI-Spezifikationen migrieren:
mintlify-scrape openapi-file [OpenAPI-Dateiname]

​
Vorbereitete Inhalte zu Ihrem Mintlify-Projekt hinzufügen

Nachdem Ihre bestehende Dokumentationsplattform gecrawlt wurde, können Sie Ihre Dokumentation auf Mintlify aufbauen.Vergewissern Sie sich, dass alle Ihre Seiten migriert wurden, und fügen Sie dann diese Dateien dem Dokumentations-Repository hinzu, das Sie während des Onboardings erstellt haben. In der Regel ist dies ein GitHub-Repository.

​
Checkliste nach der Migration

Nachdem Sie Ihre Migration (automatisiert oder manuell) abgeschlossen haben, empfehlen wir, Folgendes zu prüfen:
  • Alle Seiten werden korrekt gerendert
  • Die Navigation funktioniert wie erwartet
  • Interne Links funktionieren korrekt
  • Bilder und Assets werden korrekt geladen
  • Codeblöcke werden mit korrektem Syntax-Highlighting angezeigt
  • Die Suche funktioniert
  • Die Bereitstellung ist konfiguriert
  • Die benutzerdefinierte Domain ist eingerichtet