メインコンテンツへスキップ
前提条件:
  • Node.js バージョン 19 以上
  • docs.json ファイルを含むドキュメントリポジトリ
お使いの OS に Mintlify をインストールして実行するには、以下の手順に従ってください。
1

Mintlify CLI のインストール

npm i -g mint
2

ローカルでプレビュー

docs.json ファイルがあるドキュメントディレクトリに移動し、次のコマンドを実行します:
mint dev
ドキュメントのローカルプレビューは http://localhost:3000 で確認できます。

カスタムポート

デフォルトでは、Mintlify はポート 3000 を使用します。--port フラグを使用することで、Mintlify が動作するポートをカスタマイズできます。例えば、ポート 3333 で Mintlify を実行するには、次のコマンドを使用します:
mint dev --port 3333
既に使用されているポートで Mintlify を実行しようとすると、次に利用可能なポートが使用されます:
Port 3000 is already in use. Trying 3001 instead.

Mintlify のバージョン

各 CLI リリースは、 Mintlify の特定のバージョンに関連付けられています。ローカルプレビューが本番バージョンと一致しない場合は、CLI を更新してください:
npm mint update

リンクの検証

CLI は、ドキュメント内のリンクの検証をサポートしています。切れたリンクを特定するには、次のコマンドを使用します:
mint broken-links

デプロイ

デプロイが成功すると、以下のように表示されます:
すべてのチェックに合格したことを示すデプロイ確認メッセージのスクリーンショット。

コードのフォーマット

IDE の拡張機能を使用して、MDX を認識してフォーマットすることをお勧めします。VSCode ユーザーの場合は、構文強調表示用の MDX VSCode extension と、コードフォーマット用の Prettier を検討してください。

トラブルシューティング

これは Node.js のバージョンが古いために発生する可能性があります。以下を試してください:
  1. 現在インストールされている CLI を削除します:npm remove -g mint
  2. Node v19 以上にアップグレードします。
  3. CLI を再インストールします:npm i -g mint
解決策:デバイスのルートに移動し、~/.mintlify フォルダを削除します。その後、再度 mint dev を実行してください。
最新の CLI バージョンでの変更点については、CLI changelog を確認してください。