> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ticoag.fun/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}
mint update
```

## 校验链接

CLI 可以帮助校验文档中的链接。要查找断链（broken links），运行：

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

## 部署

如果部署成功，你会看到类似如下的提示：

<Frame>
  <img src="https://mintcdn.com/loap/HEJYj3JpRMiAxzG7/images/checks-passed.png?fit=max&auto=format&n=HEJYj3JpRMiAxzG7&q=85&s=a5b8449fe52f707524c8c707b8f1e55e" 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 extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) 获取语法高亮，并使用 [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) 进行格式化。

## 故障排查

<AccordionGroup>
  <Accordion title="Error: Could not load the &#x22;sharp&#x22; module using the darwin-arm64 runtime">
    这通常是由于 Node.js 版本过旧导致。可以尝试：

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

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

想了解最新 CLI 版本有哪些变化？查看 [CLI changelog](https://www.npmjs.com/package/mintlify?activeTab=versions)。