# mint 中文文档

规范地址：https://npmcn.com/package/mint/

版本：4\.2\.1200
npm 元数据更新时间：2026-11-04T01:40:54.635Z
中文译文更新时间：2026-11-04T05:57:30.241Z
软件包许可：Elastic-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/mint
原文对照：https://npmcn.com/package/mint/?lang=original
项目主页：https://github.com/mintlify/mint#readme
源码仓库：https://github.com/mintlify/mint

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：12.2 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=18\.0\.0
- 运行依赖：1 个
- 首次发布：2012-02-21T10:42:01.958Z
- 最新版本发布：2026-11-04T01:40:53.972Z
- 已发布版本数：1283（近 12 个月 1004 个）

## 中文简介

Mintlify命令行

## 安装

```sh
npm install mint
```

也可以使用：`pnpm add mint`、`yarn add mint`、`bun add mint`

## README

[![Mintlify Logo](https://mintlify-assets.b-cdn.net/logo.svg)](https://mintlify.com/)  

### **薄荷CLI**

Mint CLI是从命令行构建Mintlify应用程序的最简单方法。

[![Website](https://img.shields.io/website?url=https%3A%2F%2Fmintlify.com&logo=mintlify)](https://mintlify.com/) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fmintlify.com%2F)](https://twitter.com/intent/tweet?url=&text=Check%20out%20%40mintlify)

用❤建造︎by [Mintlify](https://mintlify.com/)

### 安装

```
npm i -g mint
```

要求Node 20.17及以上版本。推荐LTS版本。不支持Node 25+。

### 本地预览

#### `mint dev`

在Mintlify项目的根目录下运行以在本地预览更改。默认情况下在浏览器中打开。

```
mint dev
```

**选项**

| 国旗 | 描述 | 默认的 |
| --- | --- | --- |
| `--port <number>` | 运行预览的端口 | `3000` |
| `--no-open` | 跳过在浏览器中打开预览 | \- - - - - - |
| `--groups <group...>` | 模拟用户组进行本地测试 | \- - - - - - |
| `--disable-openapi` | 禁用OpenAPI文件生成 | \- - - - - - |

**自定义端口**

```
mint dev --port 3333
```

如果指定的端口已被使用，CLI会自动尝试下一个可用的端口。

**故障排除**

如果 `mint dev` 不工作，按顺序尝试以下步骤：

1.  确保您运行的文件夹中有 `docs.json` 文件。
2.  运行 `mint update` 获取最新版本的CLI。
3.  确保您使用的是Node 20.17或更高版本。
4.  的内容 `.mintlify` 文件夹在您的主目录。

### 验证和检查

#### `mint validate`

在严格模式下验证文档构建。在任何警告或错误时以非零代码退出-在CI中很有用。

```
mint validate
```

**选项**

| 国旗 | 描述 |
| --- | --- |
| `--groups <group...>` | 模拟用户组以进行验证 |
| `--disable <rules>` | 关闭规则或组，例如： `--disable openapi` 跳过OpenAPI |

#### `mint broken-links`

检查项目中损坏的内部链接。

```
mint broken-links
```

**选项**

| 国旗 | 描述 |
| --- | --- |
| `--check-anchors` | 也验证锚链接，如 `link-path#section` 防头段塞 |
| `--check-external` | 还要检查外部链接是否有损坏的url |
| `--check-snippets` | 也可以查看里面的链接 `<Snippet>` 组件 |

#### `mint openapi-check <filename>`

检查OpenAPI规范是否有错误。接受本地文件路径或URL。

```
mint openapi-check ./openapi.yaml
mint openapi-check https://petstore3.swagger.io/api/v3/openapi.json
```

#### `mint a11y`

检查文档中的可访问性问题。也可作为 `mint accessibility`， `mint accessibility-check`, `mint a11y-check`。

```
mint a11y
```

**选项**

| 国旗 | 描述 |
| --- | --- |
| `--skip-contrast` | 跳过颜色对比检查 |
| `--skip-alt-text` | 跳过对图像和视频的所有文本检查 |

### 创建和管理内容

#### `mint new [directory]`

创建一个新的Mintlify文档站点。默认为当前目录。

```
mint new
mint new my-docs
```

**选项**

| 国旗 | 描述 |
| --- | --- |
| `--theme <name>` | 文档站点的主题 |
| `--name <name>` | 文档项目的名称 |
| `--force` | 在非空目录中初始化 |

#### `mint rename <from> <to>`

重命名文件并在整个项目中更新对该文件的所有内部引用。

```
mint rename introduction.mdx overview.mdx
```

**选项**

| 国旗 | 描述 |
| --- | --- |
| `--force` | 重命名文件并跳过错误 |

#### `mint scrape <url>`

抓取整个文档站点并将其转换为Mintlify MDX文件。也可作为 `mint scrape site <url>`。

```
mint scrape https://example.com/docs
```

**选项**

| 国旗 | 描述 |
| --- | --- |
| `--filter <path>` | 只抓取匹配此路径的url(例如： `/docs` 匹配 `/docs` 和 `/docs/*`） |

#### `mint scrape page <url>`

抓取单个文档页面并将其转换为MDX文件。

```
mint scrape page https://example.com/docs/introduction
```

#### `mint scrape openapi <location>`

从OpenAPI规范生成MDX文件。接受本地文件路径或URL。

```
mint scrape openapi ./openapi.yaml
mint scrape openapi https://petstore3.swagger.io/api/v3/openapi.json
```

**选项**

| 国旗 | 描述 | 默认的 |
| --- | --- | --- |
| `--outDir <path>` | 文件夹，用于写入生成的文件 | \- - - - - - |
| `--overwrite` | 覆盖现有文件 | `false` |

#### `mint migrate-mdx`

将MDX OpenAPI端点页面迁移到 `x-mint` 扩展和 `docs.json`。

#### `mint upgrade`

升级 `mint.json` 来 `docs.json`。创建一个 `docs.json` 从你现有的 `mint.json`。

#### `mint workflow`

向文档存储库中添加工作流。

### 出口

#### `mint export`

将静态站点导出为zip文件以进行气隙部署。

```
mint export
mint export --output docs.zip
```

**选项**

| 国旗 | 描述 | 默认的 |
| --- | --- | --- |
| `--output <path>` | 输出zip文件路径 | `export.zip` |
| `--groups <group...>` | 模拟要导出的用户组 | \- - - - - - |
| `--disable-openapi` | 禁用OpenAPI文件生成 | \- - - - - - |

zip文件包括 `serve.js` 服务器和a `README.md` 使用在您自己的服务器上托管导出的规则 `<path>/index.html` 对于页面，回答请求时使用 `RSC: 1` 头或 `_rsc` 查询参数 `<path>/index.txt` 作为 `text/x-component` 所以客户端导航可以工作，缓存也可以 `_next/static` 和 `_mintlify/export-assets` 是不可改变的。

### CLI管理

#### `mint update`

将命令行升级到最新版本。

#### `mint version`

显示当前版本的命令行和客户端。也可作为 `mint v`。

### 开始

[创建帐户](https://mintlify.com/start) 开始使用Mintlify作为文档。

## 常见问题

### mint 是什么？

Mintlify命令行

### 如何安装 mint？

在项目目录运行 npm install mint，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 mint，可以用 npx mint 直接运行。

### mint 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/mint 是否存在。

### mint 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### mint 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### mint 可以商用吗？

mint 使用 Elastic-2\.0 许可。声明的许可为 Elastic-2\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### mint 还在维护吗？

最新版本 4\.2\.1200 发布于 2026/11/04（今天）；至今共发布 1283 个版本，其中过去 12 个月发布了 1004 个；首次发布于 2012/02/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。