mcpField
M
markdown-documentation

markdown-documentation

github.com/aj-geddes文档处理3731.3k 次安装34 周前更新
代码仓库

关于 markdown-documentation

使用标准 Markdown 和 GitHub Flavored Markdown 编写易读文档的技能，适用于编写 README、指南、Wiki 和其他项目内容的技术写作者与维护者。

主要功能

  1. 01Markdown 文本与列表格式
  2. 02链接、图片与代码块
  3. 03表格和扩展 GFM 语法
  4. 04提示框、标注与 Mermaid 图表

适用场景

  1. 01编写项目 README
  2. 02排版技术文档
  3. 03创建 GitHub 或 GitLab Wiki 页面

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill markdown-documentation

安装后在 Claude Code 中输入/markdown-documentation确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
alerts-and-callouts.md
collapsible-sections.md
extended-syntax-github-flavored-markdown.md
links-and-images.md
lists.md
mermaid-diagrams.md
text-formatting.md
templates/
doc-template.md

详细介绍

Markdown 文档

目录

概述

掌握 Markdown 语法和最佳实践，使用标准 Markdown 和 GitHub Flavored Markdown（GFM）创建格式规范、易读的文档。

适用场景

  • README 文件
  • 文档页面
  • GitHub/GitLab Wiki
  • 博客文章
  • 技术写作
  • 项目文档
  • 注释格式设置

快速入门

  • 注释格式设置
# H1 Header

## H2 Header

### H3 Header

#### H4 Header

##### H5 Header

###### H6 Header

# Alternative H1

## Alternative H2

参考指南

references/ 目录中的详细实现：

指南内容
文本格式文本格式
列表列表
链接和图片链接和图片、代码块、表格
扩展语法（GitHub Flavored Markdown）扩展语法（GitHub Flavored Markdown）
可折叠章节可折叠章节、语法高亮、徽章
提醒和提示框提醒和提示框
Mermaid 图表Mermaid 图表

最佳实践

✅ 应该做
  • 使用描述性链接文本
  • 为较长的文档添加目录
  • 为图片添加替代文本
  • 使用指定语言的代码块
  • 将行长控制在 80–100 个字符以内
  • 内部文档使用相对链接
  • 添加构建状态、覆盖率等徽章
  • 包含示例和屏幕截图
  • 使用语义换行
  • 定期测试所有链接
❌ 不应该做
  • 使用“点击这里”作为链接文本
  • 忘记为图片添加替代文本
  • 不必要地混用 HTML 和 Markdown
  • 对本地文件使用绝对路径
  • 不分段地堆砌大段文字
  • 代码块中不指定语言
  • 将图片用于文本内容（影响可访问性）

评论

支持 Markdown