💡 介绍
对接deepwiki的插件,
DeepWiki 的主要功能
- 1.自动生成详细文档
DeepWiki 分析代码仓库中的代码文件、README 文档和配置文件,自动提取关键信息,并生成结构化的知识库文档。这些文档包括:
代码仓库的功能描述
技术栈 (Technology Stack) 和依赖项
文件结构和模块描述
交互式图表 (例如架构图、流程图等)
- 2.对话式 AI 助手
用户可以直接与生成的文档进行对话,并询问有关代码仓库的任何问题。例如:
“这个项目的架构是如何设计的?”
“如何运行这个代码仓库?”
“某个特定函数的具体功能是什么?”
AI 助手基于代码仓库的内容提供准确和即时的答案,极大地促进了开发者对代码仓库的理解。
- 3.深入研究查询
除了基本的技术文档外,DeepWiki 还提供“深入研究 (In-Depth Research)”功能,类似于经验丰富的资深工程师提供的技术指导。用户可以使用此功能来深入了解代码仓库的设计理念、最佳实践和潜在的优化方向。
4.支持公共和私有仓库
公共 GitHub 仓库的文档生成完全免费。
私有仓库需要付费授权,适用于企业或团队内部使用。Apifox - API 文档、调试、Mock、测试一体化协作平台。拥有接口文档管理、接口调试、Mock、自动化测试等功能,接口开发、测试、联调效率,提升 10 倍。最好用的接口文档管理工具,接口自动化测试工具。私有仓库需要付费授权,适用于企业或团队内部使用。
📦 安装
在astrbot的插件市场搜索astrbot_plugin_deepwiki,点击安装即可
⌨️ 使用说明
命令表
| 命令 | 说明 | 例子 |
|---|---|---|
| /dw 仓库地址 询问内容 | 命令格式,dw写成deepwiki也行 | /dw NapNeko/NapCatQQ 支持接入哪些机器人框架 |
| /dw 询问内容 | 不填仓库地址,默认指向AstrBot仓库, | /dw 怎么对接NapCat |
注意:查询的仓库必须在deepwiki建立了索引,否则无法查询,请前往官网建立你仓库的索引再查询:https://deepwiki.com/
示例图
👥 贡献指南
- 🌟 Star 这个项目!(点右上角的星星,感谢支持!)
- 🐛 提交 Issue 报告问题
- 💡 提出新功能建议
- 🔧 提交 Pull Request 改进代码
📌 注意事项
- 想第一时间得到反馈的可以来作者的插件反馈群(QQ群):460973561(不点star不给进)
🤝 鸣谢
拾雪大佬的代码分享:https://github.com/MliKiowa