Skip to main content
本页介绍如何在本地编辑、预览和提交 NEC 文档站的改动。

环境准备

确保已安装:
  • Node.js 18+:用于运行 Mintlify CLI
  • Python 3.10+:用于运行文档健康检查脚本
  • Git:用于提交和推送

安装 Mintlify CLI

验证安装:

本地预览

在项目根目录(docs.json 所在目录)运行:
本地服务器默认在 http://localhost:3000 启动,保存文件后会自动热更新。
如果端口 3000 被占用,Mintlify 会自动尝试 3001、3002 等后续端口。

项目结构

当前文档站结构如下:

创建新页面

  1. 在合适目录创建 .mdx 文件
  2. 添加 YAML frontmatter:
  1. docs.jsonnavigation 中注册页面
  2. 运行 python tools/ci/check_docs.py 确认无错误
空菜单不要上线:新增导航项前,请确认目标页面已有实质内容,并且 frontmatter 完整。

图片与静态资源

  • 图片统一放入 images/ 目录
  • 引用时使用以 /images/ 开头的绝对路径:
  • 二维码、截图等建议压缩后再提交,避免仓库体积膨胀

常用组件

卡片

卡片组

步骤

更多组件请参考 Mintlify 组件文档

提交前检查

在提交 PR 或推送前,请先运行 CI 健康检查脚本:
脚本会自动检查:
  • docs.json JSON 合法性与推荐字段
  • 导航页面文件存在性
  • .mdx 文件 frontmatter 完整
  • 内部链接可解析
  • localhost 链接
  • 外部链接抽样可达性

部署

推送到 https://github.com/new-energy-coder-club/docsmain 分支后,Mintlify 会自动构建并部署到: https://docs.newenergycoder.club/ 无需手动连接 Gitee/GitHub 到 Mintlify,部署由 GitHub Actions 与 Mintlify 集成自动完成。

更多资源