SuperAPI AI 工具集

readme-generator

写作与研究

查看项目

更新于 10-16 08:10

技能介绍

用途:自动为 GitHub 仓库生成或更新结构完整、符合最佳实践的 README.md。

主要能力:按工作流分析仓库上下文(检测已有 README、从 .git/config 取仓库名、读取 mkdocs.yml 获取站点名/描述/URL、识别技术栈),生成 shields.io 徽章(MkDocs、Material、GitHub Pages、Python、JavaScript、p5.js、许可证等),并组织以下章节:概述、站点状态与指标、快速开始、仓库结构、问题反馈、许可证、致谢、联系方式,以及可选的贡献指南、引用信息和变更日志。

必要用法:技能包含支撑脚本,用于自动采集指标,例如统计章节数、Markdown 文件与字数、MicroSim 数量、术语表、FAQ、测验题、图片和图表、学习图谱统计等。脚本用法: cd skills/readme-generator/scripts python collect-site-metrics.py /path/to/repo 输出为 JSON 对象,供填充指标表格。生成前会就 README 已存在、仓库 URL 缺失、是否部署到 GitHub Pages 等提问;未指定许可证时默认使用 Creative Commons BY-NC-SA 4.0。

适用场景:新建 GitHub 仓库需要 README;更新既有 README 以符合最佳实践;项目重大变更后补充文档;发布或分享仓库前;从其他文档系统迁移后;新增技术或依赖后。

限制:资料未提供收费、价格、支持平台数量或效果数据;具体脚本实现细节、可定制参数和错误处理暂未提供;示例中的联系人(Dan McCreary)、仓库 URL 与站点 URL 需按实际项目替换。