SuperAPI AI 工具集

markdown-pro

写作与研究

查看项目

更新于 10-15 17:22

技能介绍

用途:该技能为编写专业、结构清晰的 Markdown 文档提供指导,覆盖 README、变更日志(changelog)、贡献指南和技术文档,强调现代格式、徽章与最佳实践。

主要能力:README 生成(项目概述、安装说明、带代码块的用法示例、API 文档、徽章、功能亮点、截图与演示);变更日志自动化(语义化版本格式、解析 Git 历史、自动生成发布说明、突出破坏性变更、贡献者署名);技术文档(清晰的章节层级、代码语法高亮、API 参考格式、目录、交叉引用、可折叠区块)。

使用方式:资料提供辅助脚本命令,可原样使用:生成目录 python scripts/markdown_helper.py toc README.md;从 Git 生成变更日志 python scripts/markdown_helper.py changelog --since v1.0.0 --output CHANGELOG.md;校验链接 python scripts/markdown_helper.py validate docs/。模板位于 examples/ 目录,如 README_template.md、CHANGELOG_template.md、CONTRIBUTING.md。

适用场景:为开源或内部项目撰写与维护文档,统一 README 结构、按 Keep a Changelog 与语义化版本整理发布记录、编写贡献指南。

限制:资料未说明该技能的安装方式、运行环境依赖、收费或价格、平台支持范围及实际效果,这些信息暂未提供;脚本的具体实现与可用性也未在资料中说明。