Mintlify 入门套件
点击"使用此模板"复制 Mintlify 入门套件。该入门套件包含以下示例:
- 指南页面
- 导航
- 自定义设置
- API 参考页面
- 常用组件的使用
开发
安装 Mintlify CLI 以在本地预览文档更改。使用以下命令进行安装:
npm i -g mintlify
在文档根目录(mint.json 所在位置)运行以下命令:
mintlify dev
发布更改
安装我们的 Github 应用程序,以自动将您仓库中的更改同步到部署中。将更改推送到默认分支后,系统会自动将其部署到生产环境。在您的仪表板上可以找到安装链接。
故障排除
- Mintlify dev 无法运行 - 执行
mintlify install
命令,它将重新安装依赖项。 - 页面加载显示 404 错误 - 确保您在包含
mint.json
文件的文件夹中运行。