Skip to main content
前提条件: 続行する前に、Node.js (バージョン 19 以上) をインストールしてください。
続行する前に docs.json に移行し、従来の mint.json ファイルを削除してください。
お使いのオペレーティングシステムに Mintlify をインストールして実行するには、次の step に従います: Step 1: Mintlify をインストールします: 
npm i -g mintlify
Step 2: docs ディレクトリ (docs.json ファイルがある場所) にアクセスし、次のコマンドを実行します: 
mintlify dev
ドキュメントのローカルプレビューは http://localhost:3000 で確認できます。

​
カスタムポート

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

​
Mintlify のバージョン

各 CLI version は、Mintlify の特定のバージョンに対応しています。ローカルの Web サイトが本番バージョンと一致しない場合は、CLI を更新してください。 
npm i -g mintlify@latest
CLI を使用すると、ドキュメント内の参照リンクを検証できます。リンク切れを特定するには、次のコマンドを使用します。 
mintlify broken-links

​
デプロイ

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

​
コードのフォーマット

IDE で MDX を認識して整形できるよう、拡張機能を使用することをお勧めします。VSCode をお使いの場合は、シンタックスハイライトには MDX VSCode extension、コードのフォーマットには Prettier の利用を検討してください。

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

node のバージョンが古いことが原因の可能性があります。次をお試しください。
  1. 現在インストールされている mintlify を削除します: npm remove -g mintlify
  2. Node v19 以降にアップグレードします。
  3. mintlify を再インストールします: npm install -g mintlify
対処法: ~/.mintlify フォルダを削除してから、mintlify dev をもう一度実行してください。
CLI バージョンで何が変更されたか気になりますか？ CLI の変更履歴をご覧ください。