> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-run-filter-ui-updates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 開発

> 更新を W&B Weave ドキュメントサイトに公開する前に、ドキュメントの変更をローカルでプレビューしてテストします。

<Info>
  **前提条件**: 続行する前に、Node.js (バージョン 19 以上) をインストールしてください。 <br />
  続行する前に `docs.json` に移行し、従来の `mint.json` ファイルを削除してください。
</Info>

お使いのオペレーティングシステムに Mintlify をインストールして実行するには、次の step に従います:

**Step 1**: Mintlify をインストールします:

<CodeGroup>
  ```bash npm theme={null}
  npm i -g mintlify
  ```

  ```bash yarn theme={null}
  yarn global add mintlify
  ```
</CodeGroup>

**Step 2**: docs ディレクトリ (`docs.json` ファイルがある場所) にアクセスし、次のコマンドを実行します:

```bash theme={null}
mintlify dev
```

ドキュメントのローカルプレビューは `http://localhost:3000` で確認できます。

<div id="custom-ports">
  ### カスタムポート
</div>

デフォルトでは、Mintlify はポート 3000 を使用します。`--port` フラグを使うと、Mintlify が使用するポートを変更できます。たとえば、Mintlify をポート 3333 で実行するには、次のコマンドを使用します。

```bash theme={null}
mintlify dev --port 3333
```

すでに使用中のポートでMintlifyを実行しようとすると、次に空いているポートが使用されます:

```md theme={null}
Port 3000 is already in use. Trying 3001 instead.
```

<div id="mintlify-versions">
  ## Mintlify のバージョン
</div>

各 CLI version は、Mintlify の特定のバージョンに対応しています。ローカルの Web サイトが本番バージョンと一致しない場合は、CLI を更新してください。

<CodeGroup>
  ```bash npm theme={null}
  npm i -g mintlify@latest
  ```

  ```bash yarn theme={null}
  yarn global upgrade mintlify
  ```
</CodeGroup>

<div id="validating-links">
  ## リンクの検証
</div>

CLI を使用すると、ドキュメント内の参照リンクを検証できます。リンク切れを特定するには、次のコマンドを使用します。

```bash theme={null}
mintlify broken-links
```

<div id="deployment">
  ## デプロイ
</div>

<Tip>
  [Pro
  Plan](https://mintlify.com/pricing) 以上では、エディターを無制限に利用できます。
</Tip>

デプロイに成功すると、すべてのチェックにパスしたことを示す確認メッセージが表示されます。

<div id="code-formatting">
  ## コードのフォーマット
</div>

IDE で MDX を認識して整形できるよう、拡張機能を使用することをお勧めします。VSCode をお使いの場合は、シンタックスハイライトには [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx)、コードのフォーマットには [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) の利用を検討してください。

<div id="troubleshooting">
  ## トラブルシューティング
</div>

<AccordionGroup>
  <Accordion title="エラー: darwin-arm64 ランタイムで &#x22;sharp&#x22; モジュールを読み込めませんでした">
    node のバージョンが古いことが原因の可能性があります。次をお試しください。

    1. 現在インストールされている mintlify を削除します: `npm remove -g mintlify`
    2. Node v19 以降にアップグレードします。
    3. mintlify を再インストールします: `npm install -g mintlify`
  </Accordion>

  <Accordion title="問題: 不明なエラーが発生する">
    対処法: `~/.mintlify` フォルダを削除してから、`mintlify dev` をもう一度実行してください。
  </Accordion>
</AccordionGroup>

CLI バージョンで何が変更されたか気になりますか？ [CLI の変更履歴をご覧ください。](https://www.npmjs.com/package/mintlify?activeTab=versions)