SuperAPI AI 工具集

markdown-documentation

写作与研究

查看项目

更新于 10-15 16:46

技能介绍

用途:用于掌握 Markdown 语法与最佳实践,生成格式整洁、易读的文档,适用于 README、文档页面、GitHub/GitLab Wiki、博客文章、技术写作、项目文档以及评论格式整理。

主要能力:覆盖标准 Markdown 与 GitHub Flavored Markdown(GFM)。内容包括标题层级(H1 至 H6 及替代写法)、文本格式化、列表、链接与图片、代码块与语法高亮、表格、折叠区块(Collapsible Sections)、徽章(Badges)、告警与提示(Alerts and Callouts)、Mermaid 图表,以及扩展语法。参考资料按主题分置于 references/ 目录:文本格式化、列表、链接和图片(含代码块、表格)、扩展语法、折叠区块与语法高亮与徽章、告警和提示、Mermaid 图表。

使用方式:按需查阅对应主题的参考指南;编写文档时遵循所列最佳实践,如使用描述性链接文字、为长文档添加目录、为图片添加替代文本、在代码块中标注语言、内部文档使用相对链接、添加构建状态与覆盖率等徽章、保持行宽约 80–100 字符、定期测试所有链接。应避免使用“点击这里”作为链接文字、遗漏图片替代文本、不必要地混用 HTML 与 Markdown、对本地文件使用绝对路径、创建无分段的大段文字、在代码块中省略语言标注、用图片承载文字内容。

适用场景:适合需要规范 Markdown 排版的各类技术文档与说明性内容撰写。

限制:资料未提供该技能的具体安装命令、运行环境、收费方式或自动化执行步骤,暂未提供这些信息。