> ## Documentation Index
> Fetch the complete documentation index at: https://doc.tianhao.tech/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 命令行界面">
    ```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` 标志来自定义 Mintlify 运行的端口。例如，要在端口 3333 上运行 Mintlify，请使用此命令：

```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/tianhao/UO2gITxjkZhDgsE7/images/checks-passed.png?fit=max&auto=format&n=UO2gITxjkZhDgsE7&q=85&s=f0504e6b4e2d2db28b5290575b822446" alt="Screenshot of a deployment confirmation message that says 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="错误：无法使用 darwin-arm64 运行时加载 &#x22;sharp&#x22; 模块">
    这可能是由于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=版本）。](https://www.npmjs.com/package/mintlify?activeTab=版本）。)