- 已全局安装 Mintlify CLI,或使用
npx mint运行命令。
http://localhost:3000 启动。编辑时,更改会实时显示。
默认情况下,预览会自动在浏览器中打开。要阻止浏览器打开,请使用 --no-open 选项:
docs.json 文件的目录中运行 mint dev,CLI 会根据你的目录结构生成一个 docs.json 文件。生成的导航遵循以下规则:
- 为目录根级的 Markdown 和 MDX 文件创建一个名为 Introduction 的分组。
- 为每个顶级子目录创建一个分组,嵌套的子目录会成为子分组。
- 名为
index或readme的页面在其分组中排在最前面。其他页面和文件夹按字母顺序排序;如果标题包含数字,则按数字顺序排序。 - 分组名称使用子目录名称,并去掉开头的数字前缀。例如,名为
01-getting-started的文件夹会成为名为 Getting started 的分组。 - CLI 会跳过以
.或_开头的文件和文件夹、node_modules和snippets文件夹,以及.mintignore文件中列出的路径。
package.json 文件的 name 字段。如果没有 package.json 文件,CLI 会使用目录名称。编辑生成的 docs.json 文件以自定义你的导航、主题和颜色。
你需要使用 Mintlify 账户对 CLI 进行身份验证,才能启用搜索和 AI 助手。
mint login 命令完成身份验证后,CLI 会将你的凭据存储在操作系统的凭据存储中,以便你在各会话之间保持登录状态。CLI 还会提示你选择一个默认项目。
登录后,运行 mint dev 启动带有搜索和助手功能的本地预览。助手使用与已部署文档站点相同的索引内容。
要检查你的身份验证状态,请运行:
--port 选项:
localhost 的连接。要在手机或网络中的其他电脑上打开预览,请使用 --host 选项:
--disable-openapi 选项跳过 OpenAPI 处理以提高性能:
--disable-prefetch 选项禁用预加载:
--groups 选项以特定身份验证组进行预览:
<Visibility for="signed-in"> 内容,请使用 --signed-in 选项以不属于任何组的已登录读者身份预览。--groups 选项同样以已登录读者身份预览。