NEC 新能源开发者社区文档站

面向机器人竞赛与真实工程项目的开源工程社区文档站。沉淀 ROBOCON、RoboMaster、智能车等赛事的机械、嵌入式、机器视觉与运营经验。

在线访问

https://docs.newenergycoder.club/

推送代码到本仓库 main 分支后，Mintlify 会自动构建并部署。

技术栈

• Mintlify — 文档站点框架
• MDX — 页面内容
• Python — 文档健康检查脚本

本地开发

环境要求

• Node.js 20.17–24
• Python 3.10+
• Git

安装依赖

npm ci

项目通过 package-lock.json 固定 Mintlify 与 CSS 检查工具的版本，无需全局安装 CLI。

启动预览

在项目根目录运行：

npm run dev

本地服务器默认在 http://localhost:3000 启动，保存文件后自动热更新。

提交前检查

npm run insights:generate
npm run insights:sync
npm run check:css
npm run validate
python tools/ci/check_docs.py

检查项包括 PageInsights 产物与挂载同步、docs.json 合法性、CSS 解析、Mintlify 配置、导航页面存在性、MDX frontmatter 完整性和内部链接可解析性等。

项目结构

说明：Wiki 中的技术教程已按主题迁移到对应 SIG / 工具目录（如机械设计、嵌入式软件、AI 工具），wiki/ 主要保留新人入口、社区协作、培训资源与安全规范等飞书原始沉淀。

.
├── index.mdx                 # 站点首页
├── docs.json                 # Mintlify 站点配置与导航
├── style.css                 # 自定义主题样式
├── robots.txt                # 搜索引擎与 AI 爬虫指引
├── llms.txt                  # LLM 抓取指引
├── AGENTS.md                 # 给 AI Agent 的项目说明
├── images/                   # 图片资源
├── logo/                     # 站点 Logo（明暗主题）
├── public/                   # 静态附件（PPT、资料包等）
├── snippets/                 # MDX 可复用片段
├── templates/                # 竞赛/项目/周报文档模板
├── start-here/               # 快速开始与新手上路
├── training/                 # 新人训练营系列课程
├── modules/                  # 项目模块总览
├── mechanical/               # 机械设计专题
│   └── lumenpnp/             # LumenPnP 开源贴片机组装与使用文档（自飞书迁移）
├── vision/                   # 机器视觉专题
├── embedded-software/        # 嵌入式软件专题
├── ai-tools/                 # AI 工具指南
├── competition/              # 竞赛概览
├── curc26/                   # CURC 2026 赛季文档
├── community/                # 社区介绍与治理
├── contributing/             # 贡献指南
├── solutions/                # 外部解决方案（飞书、LiblibAI 等）
├── wiki/                     # 飞书 Wiki 导出快照（新人/社区/资源类沉淀）
└── tools/ci/                 # CI 检查脚本

内容来源与导入

• wiki/ 与部分专题文档（如 mechanical/lumenpnp/）来自飞书 Wiki，可通过仓库内的 .kimi/skills/feishu-to-nec-mdx/ Skill 从飞书增量导入并自动转换为带 frontmatter 的 MDX。
• 单篇飞书文档需要在飞书内部克隆备份（不动 MDX）时，用 .kimi/skills/feishu-doc-clone/：正文逐块搬运，图片下载后传 Cloudflare R2 再改写成 CDN 链接，断点续跑。
• 大文件（PDF、压缩包、视频等）托管于 Cloudflare R2 CDN（https://cdn.newenergycoder.club），页面只引用 CDN 链接，不入 Git 仓库。
• 旧 Wiki URL 已通过 docs.json 的 redirects 自动跳转。

贡献指南

1. 阅读 贡献指南 与 工作流。
2. 创建或修改 .mdx 页面，确保包含 title 与 description 的 YAML frontmatter。
3. 在 docs.json 的 navigation 中注册新页面。
4. 运行 python tools/ci/check_docs.py 确认无错误。
5. 提交 PR 并等待 Review。

社区

• 官网：https://www.newenergycoder.club/
• GitHub 主代码仓：https://github.com/necc-hub/new_energy_coder_club
• GitHub 文档仓库：https://github.com/necc-hub/docs
• ROBOCON 官网：https://www.cnrobocon.net/

许可证

本项目采用 木兰宽松许可证第 2 版（Mulan PSL v2）。