文档
本地运行和修改文档的指南
先决条件
开始使用
1
安装Mintlify CLI
使用npm全局安装Mintlify CLI:
2
克隆仓库
克隆您的文档仓库:
3
启动开发服务器
在文档根目录运行开发服务器:
文档将在http://localhost:3000
可用
进行更改
故障排除
常见问题和解决方案:
- 如果
mintlify dev
失败,尝试mintlify install
重新安装依赖 - 确保您在包含
mint.json
的正确目录中 - 如果更改没有反映,清除浏览器缓存
始终将更改提交到版本控制:
部署
如果您已配置Mintlify GitHub应用,推送到默认分支的更改将自动部署。
为获得最佳部署效果:
- 首先在本地测试所有更改
- 确保所有图片和链接都正常工作
- 验证导航结构