このガイドでは、既存のドキュメントを Mintlify に移行する方法を解説します。対応プラットフォームでは自動移行を、プロセスを細部まで管理したい場合は手動移行を選択してください。

​
移行パスを選ぶ

自動移行

Docusaurus、ReadMe、または GitBook から移行する場合は、ツールを使って移行を自動化できます。

手動移行

上記以外のプラットフォームから移行する場合は、ガイドに沿ってコンテンツを移行してください。
@mintlify/scraping パッケージでドキュメントを移行します。パッケージがコンテンツをスクレイピングし、Mintlifyのコンポーネントを用いる形式へ変換します。

​
対応プラットフォーム

Docusaurus

ReadMe

GitBook（ベータ）

ドキュメントを他のプラットフォームでホストしている場合は、手動移行の手順をご覧ください。

​
スクレイパーのインストール方法

はじめに、@mintlify/scraping パッケージをインストールします。
npm install @mintlify/scraping@latest -g

​
ページやセクションのスクレイピング

移行ツールはドキュメントプラットフォームを自動検出してコンテンツを変換します。用意されたファイルはデフォルトで ./docs にローカル保存されます。大規模なドキュメントサイトは、サイト全体を一度に移行するのではなく、小さなセクション単位で段階的に移行してください。セクション全体を移行：
mintlify-scrape セクション https://your-docs-site.com/docs
単一ページを移行：
mintlify-scrape page https://your-docs-site.com/docs/getting-started
OpenAPI 仕様を移行：
mintlify-scrape openapi-file [openApiFilename]

​
準備済みのコンテンツを Mintlify プロジェクトに追加する

既存のドキュメンテーションプラットフォームのスクレイピングが完了したら、Mintlify 上でドキュメントの作成を開始できます。すべてのページの移行が完了していることを確認し、オンボーディング時に作成したドキュメント用リポジトリにこれらのファイルを追加してください。通常はGitHubリポジトリです。

​
移行後のチェックリスト

自動・手動いずれの方法でも、移行完了後は次を確認することをおすすめします：
  • すべてのページが正しく表示される
  • ナビゲーションが意図どおりに機能する
  • 内部リンクが正しく遷移する
  • 画像やアセットが正しく読み込まれる
  • コードブロックが適切にシンタックスハイライトされて表示される
  • 検索機能が正常に動作する
  • デプロイが適切に設定されている
  • カスタムドメインが設定されている