跳转到主要内容

​
先决条件

安装Node.js

  • 下载并安装Node.js
  • 推荐版本：16.x或更高
  • 安装Git用于版本控制
  • 克隆仓库时需要

​
开始使用

1

安装Mintlify CLI

使用npm全局安装Mintlify CLI：
npm i -g mintlify
2

克隆仓库

克隆您的文档仓库：
git clone https://github.com/blinko-space/blinko-docs
cd blinko-docs
3

启动开发服务器

在文档根目录运行开发服务器：
mintlify dev
文档将在http://localhost:3000可用

​
进行更改

  • 修改仓库中的.mdx文件
  • 更改将在浏览器中热重载
  • 使用Markdown和MDX组件
  • 将图片放在/images目录中
  • 使用相对路径引用它们：
<img src="/images/example.png" />
  • 编辑mint.json修改导航结构
  • 在MDX文件中更新页面元数据

​
故障排除

常见问题和解决方案：
  • 如果mintlify dev失败，尝试mintlify install重新安装依赖
  • 确保您在包含mint.json的正确目录中
  • 如果更改没有反映，清除浏览器缓存
始终将更改提交到版本控制：
git add .
git commit -m "Update documentation"
git push

​
部署

如果您已配置Mintlify GitHub应用，推送到默认分支的更改将自动部署。
为获得最佳部署效果：
  • 首先在本地测试所有更改
  • 确保所有图片和链接都正常工作
  • 验证导航结构
⌘I