開発

ドキュメントを更新するために変更をローカルでプレビュー

前提条件: 続行する前に、Node.js（バージョン19以上）をインストールしてください。

お使いのオペレーティングシステムでMintlifyをインストールして実行する手順に従ってください：

ステップ1: Mintlifyをインストール：

npm

npm i -g mintlify

ステップ2: ドキュメントディレクトリ（mint.jsonファイルがある場所）に移動し、次のコマンドを実行：

mintlify dev

ドキュメントのローカルプレビューがhttp://localhost:3000で利用可能になります。

カスタムポート

デフォルトでは、Mintlifyはポート3000を使用します。--portフラグを使用してMintlifyが実行するポートをカスタマイズできます。例えば、ポート3333でMintlifyを実行するには、このコマンドを使用します：

mintlify dev --port 3333

既に使用中のポートでMintlifyを実行しようとした場合、次に利用可能なポートを使用します：

Port 3000 is already in use. Trying 3001 instead.

Mintlifyバージョン

各CLIリリースは特定のMintlifyバージョンに関連付けられていることに注意してください。ローカルウェブサイトがプロダクションバージョンと一致しない場合は、CLIを更新してください：

npm

npm i -g mintlify@latest

リンクの検証

CLIは、ドキュメント内で作成された参照リンクの検証を支援できます。壊れたリンクを特定するには、次のコマンドを使用します：

mintlify broken-links

デプロイメント

プロプラン以上で無制限の編集者が利用可能です。

デプロイメントが成功すると、次のように表示されるはずです：

コードフォーマット

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

トラブルシューティング

エラー: Could not load the "sharp" module using the darwin-arm64 runtime

これは古いバージョンのnodeが原因の可能性があります。次を試してください：

1. 現在インストールされているmintlifyのバージョンを削除：npm remove -g mintlify
2. Node v19以上にアップグレード。
3. mintlifyを再インストール：npm install -g mintlify

問題: 不明なエラーが発生

解決方法：デバイスのルートに移動し、~/.mintlifyフォルダを削除してください。その後、mintlify devを再度実行してください。

CLIバージョンで何が変更されたか気になりますか？CLIチェンジログをチェックしてください。