用途:该技能用于为 GitHub 仓库自动生成或更新结构规范、符合最佳实践的 README.md,特别针对基于 MkDocs 的智能教科书项目,也可适配其他仓库类型。
主要能力:生成技术徽章(MkDocs、Material、GitHub Pages、Claude Code、Claude Skills、许可证及 Python、JavaScript、p5.js 等)、项目概览、站点状态与指标表、入门与本地构建部署说明、仓库结构树、问题反馈、许可证、致谢、联系方式,以及贡献指南、引用信息、变更日志等可选章节。指标须读取 docs/learning-graph/book-metrics.json,不手工重新统计概念、章节或字数;缺失时可用 bk-generate-book-metrics 或 python3 "$BK_HOME/src/book-metrics/book-metrics.py" docs 重新生成。
使用方式:先分析仓库上下文(README 是否存在、仓库名、mkdocs.yml、docs 目录、依赖文件),必要时向用户询问仓库 URL 或站点 URL;再按步骤生成徽章、概览、指标、入门、结构、反馈、许可证、致谢、联系等章节,最后校验链接与格式并写入根目录 README.md。
适用场景:新建仓库、更新旧 README、项目重大变更后、发布或分享前、迁移文档系统后、新增技术依赖后。
限制:资料未提供具体安装命令、收费方式或平台支持范围;默认许可证为 CC BY-NC-SA 4.0,但应以仓库实际许可证文件为准;不应添加指向自身仓库的 GitHub 徽章。