Skip to main content
このガイドは、公開前に W&B Weave ドキュメントの変更をローカルでプレビューしたいドキュメントコントリビューター向けです。お使いのマシンで Mintlify CLI を実行すると、編集内容が正しく表示されることを確認し、壊れたリンクを見つけ、デプロイを待たずにすばやく修正を繰り返せます。
前提条件: 続行する前に、Node.js (バージョン 19 以上) をインストールしてください。
続行する前に docs.json に移行し、従来の mint.json ファイルを削除してください。

​
Mintlify をインストールして実行する

お使いのオペレーティングシステムに Mintlify をインストールして実行するには、次の step に従います:
  1. Mintlify をインストールします: 
    npm i -g mintlify
  2. docs ディレクトリ (docs.json ファイルがある場所) にアクセスし、ローカルプレビューサーバーを起動します: 
    mintlify dev
ドキュメントのローカルプレビューは http://localhost:3000 で確認できます。これで、公開されている Weave ドキュメントサイトを反映したローカル環境が実行されます。

​
カスタムポート

デフォルトでは、Mintlify はポート 3000 を使用します。お使いのマシンですでにポート 3000 が使用中である場合や、複数のプレビューを同時に実行したい場合は、--port フラグを使うと、Mintlify が使用するポートを変更できます。たとえば、Mintlify をポート 3333 で実行するには、次のコマンドを使用します。 
mintlify dev --port 3333
すでに使用中のポートでMintlifyを実行しようとすると、次に空いているポートが使用されます: 
Port 3000 is already in use. Trying 3001 instead.

​
Mintlify のバージョン

CLI を本番の Mintlify バージョンと同期させ、ローカルのプレビューが公開サイトで読者に表示される内容と一致するようにしてください。各 CLI version は、Mintlify の特定のバージョンに対応しています。ローカルの Web サイトが本番バージョンと一致しない場合は、CLI を更新してください。 
npm i -g mintlify@latest
リンク切れは読者の体験を損なうため、プルリクエストを作成する前に、変更内容に無効な参照がないか確認してください。CLI を使うと、ドキュメント内の参照リンクを検証できます。リンク切れを特定するには、mintlify broken-links を実行します。 
mintlify broken-links

​
デプロイ

Pro Plan 以上では、エディターを無制限に利用できます。
デプロイに成功すると、すべてのチェックにパスしたことを示す確認メッセージが表示されます。

​
コードのフォーマット

一貫した MDX のフォーマットにより、変更内容のレビューがしやすくなり、意図しない構文エラーも減らせます。IDE で MDX を認識して整形できるよう、拡張機能を使用することをお勧めします。VSCode をお使いの場合は、シンタックスハイライトには MDX VSCode extension、コードのフォーマットには Prettier の利用を検討してください。

​
トラブルシューティング

以下のセクションでは、Mintlify CLI をローカルで実行する際によく発生する問題と、その解決方法について説明します。
これは、Node.js のバージョンが古いことが原因である可能性があります。以下をお試しください。
  1. インストール済みの mintlify を削除します: npm remove -g mintlify.
  2. Node.js を v19 以降にアップグレードします。
  3. mintlify を再インストールします: npm install -g mintlify.
解決策: デバイスのルートディレクトリに移動し、~/.mintlify フォルダーを削除します。その後、mintlify dev をもう一度実行します。
CLI バージョンで何が変更されたか気になりますか？詳細は、CLI changelogをご覧ください。