用途:这是一个专业的 Markdown 文档编写技能,面向 README、变更日志(changelog)、贡献指南(contribution guide)和技术文档的撰写,强调现代格式、徽章与最佳实践。
主要能力:
- README 生成:项目概述、安装说明、含代码块的使用示例、API 文档、徽章与 shields、特性高亮、截图与演示。
- 变更日志自动化:语义化版本格式、解析 git 历史、生成发布说明、突出破坏性变更、标注贡献者。
- 技术文档:清晰的章节层级、代码语法高亮、API 参考格式、目录(TOC)、交叉引用、折叠/展开区块。
使用方式(资料提供的辅助脚本命令,保持原样):
- 生成目录:python scripts/markdown_helper.py toc README.md
- 从 git 生成变更日志:python scripts/markdown_helper.py changelog --since v1.0.0 --output CHANGELOG.md
- 校验 Markdown 链接:python scripts/markdown_helper.py validate docs/ 模板位于 examples/ 目录,如 README_template.md、CHANGELOG_template.md、CONTRIBUTING.md。
适用场景:为开源或内部项目撰写和维护结构化文档、发布记录与协作规范。
限制:资料未说明该技能的具体安装方式、运行环境依赖、收费与价格、支持平台及效果保证;脚本的实际可用性、参数细节和模板内容暂未提供。以上能力依据公开资料整理,缺失事实暂未提供。