> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ficcaurora.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# 开发

> 在本地预览更改以更新你的文档

<Info>
  **前提条件**：

  * Node.js 版本 19 或更高
  * 包含 `docs.json` 文件的文档仓库
</Info>

按照以下步骤在你的操作系统上安装并运行 Mintlify。

<Steps>
  <Step title="安装 Mintlify CLI">
    ```bash theme={null}
    npm i -g mint
    ```
  </Step>

  <Step title="本地预览">
    进入包含 `docs.json` 的文档目录，运行以下命令：

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

    本地文档预览可通过 `http://localhost:3000` 访问。
  </Step>
</Steps>

## 自定义端口

默认情况下，Mintlify 使用 3000 端口。你可以通过 `--port` 标志自定义运行端口。例如在 3333 端口运行：

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

如果你尝试使用的端口已被占用，Mintlify 会自动使用下一个可用端口：

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

## Mintlify 版本

每个 CLI 版本都对应一个 Mintlify 版本。如果本地预览与线上版本不一致，请更新 CLI：

```bash theme={null}
npm mint update
```

## 链接校验

CLI 可以帮助校验文档中的链接。要识别断链，请使用以下命令：

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

## 部署

部署成功后，你应当能看到如下提示：

<Frame>
  <img src="https://mintcdn.com/aurora-53895475/UTtc067M-ZOmfBb7/images/checks-passed.png?fit=max&auto=format&n=UTtc067M-ZOmfBb7&q=85&s=5a1eb8af13edd04aa5ba3686b1e030e1" alt="部署确认消息的截图，显示 All checks have passed。" style={{ borderRadius: '0.5rem' }} width="1100" height="346" data-path="images/checks-passed.png" />
</Frame>

## 代码格式化

建议在 IDE 中安装扩展以识别并格式化 MDX。若你使用 VSCode，可考虑用于语法高亮的 [MDX VSCode 扩展](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) 与用于代码格式化的 [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)。

## 故障排查

<AccordionGroup>
  <Accordion title="错误：Could not load the &#x22;sharp&#x22; module using the darwin-arm64 runtime">
    可能由于 Node 版本过旧。请尝试：

    1. 移除当前安装的 CLI：`npm remove -g mint`
    2. 升级到 Node v19 或更高。
    3. 重新安装 CLI：`npm i -g mint`
  </Accordion>

  <Accordion title="问题：遇到未知错误">
    解决方案：到设备根目录删除 `~/.mintlify` 文件夹，然后重新运行 `mint dev`。
  </Accordion>
</AccordionGroup>

想了解最新 CLI 版本的变更？请查看 [CLI 更新日志](https://www.npmjs.com/package/mintlify?activeTab=versions)。