自动生成和维护项目 Wiki 文档的 Claude Code 插件,提供文档生成、Git 提交助手和会话管理功能。
- 智能增量更新 - 只更新受代码变更影响的文档,性能提升 60-80%
- 手动编辑保护 - 自动识别并保留用户手动编辑的内容
- 智能变更检测 - Git diff + 哈希值双重检测机制
- 元数据追踪 - 动态追踪文档与源文件的映射关系
- 配置驱动:通过
{output_dir}/wiki-config.json自定义生成行为 - 智能检测:自动识别项目技术栈并生成相应文档
- 多语言支持:支持中文和英文文档生成
- 分层结构:按照项目标准组织文档(概述、架构、API、快速开始等)
- 模板系统:提供丰富的文档模板,支持自定义
# 生成 Wiki 文档(默认增量模式)
/wiki-generate
# 完整重新生成(覆盖所有现有文档)
/wiki-generate --full
# 显式增量更新
/wiki-generate --incremental- 约定式提交:自动生成符合规范的提交消息
- 表情符号:为每种提交类型添加合适的表情符号
- 提交前检查:可选的 lint、build 和文档更新检查
- 智能分析:自动检测更改并建议是否需要拆分提交
- 保存会话:保存 Claude Code 会话状态供后续使用
- 会话恢复:快速恢复之前的工作上下文
- 数据迁移:提供会话数据迁移脚本
# 在 Claude Code 中运行
/plugin marketplace add winwin-inc/claude-plugins然后安装插件:
/plugin install winwin-code-assist@winwin-inc/claude-plugins-
克隆仓库
git clone https://github.com/winwin-inc/claude-plugins.git cd claude-plugins/repo-wiki -
在 Claude Code 中添加本地市场
# 在 Claude Code 中运行 /plugin marketplace add /path/to/claude-plugins -
安装插件
/plugin install winwin-code-assist@claude-plugins
# 在命令行中启动 Claude Code 并加载插件
claude --plugin-dir /path/to/claude-plugins这种方式适合开发测试,无需安装即可使用插件。
# 生成 Wiki 文档(使用默认配置)
/wiki-generate
# 完整重新生成(覆盖所有现有文档)
/wiki-generate --full配置文件位于 {output_dir}/wiki-config.json。首次运行 /wiki-generate 时,系统会自动创建配置文件。
默认位置:docs/wiki-config.json
{
"output_dir": "docs",
"exclude_patterns": [
"node_modules",
"dist",
".git",
"build"
],
"include_patterns": [
"src/**/*.ts",
"lib/**/*.ts"
],
"template_dir": ".claude-plugin/templates/wiki-generate",
"quality_threshold": 80,
"diagrams": {
"enabled": true,
"detail_level": "medium"
},
"language": "zh",
"tech_stack": {
"backend": ["python", "fastapi"],
"frontend": ["react", "typescript"],
"database": ["postgresql"]
}
}| 选项 | 类型 | 默认值 | 说明 |
|---|---|---|---|
output_dir |
string | "docs" |
文档输出目录 |
exclude_patterns |
array | ["node_modules"] |
排除的文件模式 |
include_patterns |
array | ["**/*"] |
包含的文件模式 |
template_dir |
string | ".claude-plugin/templates/wiki-generate" |
模板目录 |
quality_threshold |
number | 80 |
文档质量阈值(0-100) |
diagrams.enabled |
boolean | true |
是否生成图表 |
diagrams.detail_level |
string | "medium" |
图表详细程度(low/medium/high) |
language |
string | "zh" |
文档语言(zh/en) |
tech_stack |
object | {} |
技术栈配置 |
docs/
├── index.md # 文档索引
├── overview.md # 项目概述
├── quickstart.md # 快速开始
├── architecture.md # 系统架构
├── api.md # API 文档
├── development.md # 开发指南
└── modules/ # 模块文档
├── module-name.md
└── ...
# 创建标准提交(运行提交前检查)
/commit
# 跳过提交前检查
/commit --no-verify默认运行以下检查:
pnpm lint- 代码质量检查pnpm build- 构建验证pnpm generate:docs- 文档更新
| 类型 | 表情符号 | 说明 |
|---|---|---|
feat |
✨ | 新功能 |
fix |
🐛 | 错误修复 |
docs |
📝 | 文档更改 |
style |
💄 | 代码风格更改 |
refactor |
♻️ | 代码重构 |
perf |
⚡ | 性能改进 |
test |
✅ | 测试相关 |
chore |
🔧 | 工具、配置 |
✨ feat: 添加用户认证系统
- 实现登录/注册功能
- 添加 JWT 认证
- 集成 OAuth2.0
# 保存当前会话
/save-session
# 指定会话名称
/save-session feature-implementation会话默认保存在:
docs/plans/sessions/
└── 2026-01-06-feature-implementation.md
如果你有旧版本的会话数据,可以使用迁移脚本:
# 运行迁移脚本
./scripts/migrate-sessions.sh这将:
- 备份现有数据到
docs/claude-sessions/backup/ - 迁移会话到
docs/plans/sessions/ - 验证迁移结果
claude-plugins/
├── .claude-plugin/ # 插件配置
│ ├── plugin.json # 插件元数据
│ ├── templates/ # Wiki 生成模板
│ │ └── wiki-generate/ # 文档模板
│ │ ├── en/ # 英文模板
│ │ ├── zh/ # 中文模板
│ │ └── *.template # 通用模板
│ └── scripts/ # 实用脚本
│ └── migrate-sessions.sh
├── commands/ # Claude Code 命令
│ ├── commit.md # Git 提交助手
│ ├── save-session.md # 会话管理
│ └── wiki-generate.md # Wiki 生成器
├── templates/ # 插件资源(已移动)
└── scripts/ # 插件脚本(已移动)
# 查看所有已添加的市场
/plugin marketplace list# 查看来自所有市场的可用插件
/plugin# 从市场来源刷新插件列表
/plugin marketplace update winwin-inc/claude-plugins# 从配置中移除市场
/plugin marketplace remove winwin-inc/claude-plugins在项目根目录的 .claude/settings.json 中配置自动市场安装:
{
"extraKnownMarketplaces": {
"winwin-plugins": {
"source": {
"source": "github",
"repo": "winwin-inc/claude-plugins"
}
}
},
"enabledPlugins": [
"winwin-code-assist@winwin-plugins"
]
}当团队成员信任项目文件夹时,Claude Code 会自动安装这些市场和插件。
-
复制默认模板:
cp -r templates/wiki-generate my-templates
-
修改模板文件(支持变量插值):
# {{PROJECT_NAME}} **作者**: {{AUTHOR}} **版本**: {{VERSION}} **技术栈**: {{TECH_STACK}}
-
在
wiki-config.json中指定模板目录:{ "template_dir": "my-templates" }
# 使用 --plugin-dir 测试本地插件
claude --plugin-dir /path/to/repo-wiki-
检查插件是否加载:
# 在 Claude Code 中 /agents -
查看可用命令:
/
-
查看插件日志:
# Claude Code 日志位置 ~/.claude/logs/
欢迎贡献!请遵循以下步骤:
- Fork 本仓库
- 创建特性分支 (
git checkout -b feature/amazing-feature) - 提交更改 (
git commit -m '✨ feat: add amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 开启 Pull Request
- 使用
/commit命令创建提交 - 遵循约定式提交规范
- 添加必要的测试
- 更新相关文档
A: 请确保:
- 插件市场已正确添加:
/plugin marketplace list - 插件已安装:输入
/plugin查看可用插件 - 命令文件在插件根目录的
commands/目录 plugin.json配置正确且包含必需字段- 如果使用
--plugin-dir,确保路径正确
A: 检查:
{output_dir}/wiki-config.json配置是否正确(默认为docs/wiki-config.json)- 输出目录是否有写权限
- 模板文件是否完整
- 查看错误日志获取详细信息
A: 编辑 commands/commit.md,修改以下部分:
# 默认运行
pnpm lint
pnpm build
pnpm generate:docs替换为你项目的实际命令。
A: 当前支持:
- 中文(zh)- 默认
- 英文(en)
可以扩展模板以支持更多语言。
A: 参考以下步骤:
- 创建 GitHub 仓库
- 在根目录添加
.claude-plugin/marketplace.json文件 - 在
plugins数组中列出你的插件 - 使用
/plugin marketplace add owner/repo安装市场
详见:插件市场文档
- 智能增量更新 - 只更新受代码变更影响的文档,性能提升 60-80%
- 手动编辑保护 - 自动识别并保留用户手动编辑的内容
- 变更检测系统 - Git diff + 哈希值双重检测机制
- 元数据追踪 - 动态追踪文档与源文件的映射关系
- 配置解析库 - 统一管理配置文件路径和初始化
- 统一 Wiki 模板目录结构
- 为命令文件添加 YAML frontmatter 元信息
- 使用 Python 替代 sed -i 确保 macOS 兼容性
- 优化配置文件解析逻辑
- 防止测试代码中的数据模型被提取到数据模型文档
- 修复 save-session 命令中的 bash 算术扩展语法错误
- Wiki 文档生成器
- Git 提交助手(约定式提交 + 表情符号)
- 会话管理(保存/恢复/迁移)
- 优化插件目录结构以符合 Claude Code 规范
- 简化 plugin.json 配置
- 添加多语言模板支持
- 修复命令无法识别的问题
- 修复插件安装后无可用命令的问题
本项目采用 MIT 许可证 - 详见 LICENSE 文件
- Building My First Claude Code Plugin - 实用插件开发教程
- Claude Code Plugin 2025 指南 - 2025年插件系统更新
- 如何用插件定制你的 Claude Code - 中文插件定制指南
Winwin.Inc Team
- 网站: https://winwin.inc
- 邮箱: support@winwin.inc
- GitHub: @winwin-inc
感谢 Anthropic 团队开发 Claude Code 和强大的插件系统!
Made with ❤️ by Winwin.Inc Team