M5-Git-Doc Project

这是一个用于从 DeepWiki 平台获取 M5Stack 相关项目文档的工具。该项目使用 MCP（Model Context Protocol）与 DeepWiki 服务器进行通信，自动获取并保存项目文档到本地目录。文档目录由本地脚本维护，不依赖 Git 远程提交同步。

项目功能

• 通过 MCP 协议与 DeepWiki 服务器通信
• 自动获取指定 M5Stack 项目的 Wiki 内容
• 将获取的文档保存为 Markdown 文件
• 支持批量处理多个项目
• 自动创建项目目录和文件名格式化

项目结构

m5-git-doc/
├── get_from_deepwiki.py      # 主程序入口
├── M5CardPuter/             # M5CardPuter 项目文档
├── M5GFX/                   # M5GFX 图形库文档
├── M5Stack/                 # M5Stack 核心库文档
├── M5Unified/               # M5Unified 统一库文档
├── M5Unit-ENV/              # M5Unit-ENV 环境传感器文档
├── M5UnitUnified/           # M5UnitUnified 单元设备文档
├── StackChan/               # StackChan 项目文档
├── StackFlow/               # StackFlow 项目文档
└── README.md               # 项目说明文档

安装依赖

该项目需要 Python 3.7 或更高版本。安装所需依赖：

pip install mcp

使用方法

1. 运行主程序：

   python get_from_deepwiki.py

2. 配置要获取的项目： 编辑 get_from_deepwiki.py 文件中的 REPOS 列表，取消注释要获取的项目：

   REPOS = [
       "M5Stack", 
       "M5Unified", 
       "M5Cardputer", 
       "StackFlow", 
       "M5GFX", 
       "M5UnitUnified", 
       "M5Unit-ENV", 
       "StackChan"
   ]

3. 运行程序后，文档将自动保存到对应的项目目录中。已有同名页面会被覆盖，未返回的旧页面不会被删除。

支持的项目

该工具支持以下 M5Stack 相关项目的文档获取：

• M5CardPuter: 便携式卡片电脑项目
• M5GFX: 图形显示库
• M5Stack: 核心开发板平台
• M5Unified: 统一库框架
• M5Unit-ENV: 环境传感器单元
• M5UnitUnified: 单元设备统一接口
• StackChan: 开源机器人项目
• StackFlow: 模块化开发平台

技术原理

• 使用 MCP（Model Context Protocol）协议与 DeepWiki 服务器通信
• 采用 MCP Streamable HTTP 进行异步通信
• 自动解析 Wiki 内容并格式化为 Markdown 文件
• 文件名安全处理，避免非法字符

注意事项

• 需要稳定的网络连接
• 程序会自动创建项目目录
• 如果目录已存在，文件会被覆盖
• 建议定期更新文档以获取最新内容

许可证

本项目使用 MIT 许可证。

作者

M5Stack 社区

贡献

欢迎提交 Issue 和 Pull Request 来改进这个项目。