安装 Mintlify
首先,确保安装了 Node.js (18+),然后安装 Mintlify CLI:本地预览
在项目根目录运行:http://localhost:3000 启动,自动检测文件变化并热更新。
文档结构
创建新页面
- 创建
.mdx文件 - 添加 frontmatter:
- 在
docs.json中添加导航
组件使用
卡片
卡片组
步骤
检查链接
运行以下命令检查死链:部署
文档会自动部署到 Mintlify 平台。提交更改到仓库后:- 连接 Gitee/GitHub 仓库到 Mintlify
- 推送更改到主分支
- 自动构建和部署