关于 markdown
GitHub Flavored Markdown(GFM)语法参考技能,面向编写 GitHub 内容的用户。涵盖标准 Markdown 及 GitHub 在议题、PR、讨论和 .md 文件中的扩展,并提供常见限制提示。
主要功能
- 01常用文本与代码格式语法
- 02任务列表与嵌套列表规则
- 03提醒、脚注和提及语法
- 04锚点生成与常见陷阱
适用场景
- 01查找 GitHub Markdown 语法
- 02检查列表、换行和锚点格式
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ bsene/ skills --skill markdown安装后在 Claude Code 中输入/markdown确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/alerts-footnotes-mentions.mdlinks-and-images.mdlists-and-tasks.mdquick-ref.mdtext-and-headings.md详细介绍
GitHub Flavored Markdown(GFM)
基于官方的 GitHub 基础写作与格式设置语法参考文档。
GFM 是标准 Markdown 的超集,包含针对问题、PR、讨论、评论和 .md 文件的 GitHub 专属扩展。
语法一览
| 功能 | 语法 |
|---|---|
| 标题 | # H1 … ###### H6 |
| 粗体 | **text** |
| 斜体 | _text_ |
| 删除线 | ~~text~~ |
| 链接 | [text](url) |
| 图片 |  |
| 行内代码 | `code` |
| 代码块 | ``` lang … ``` |
| 引用块 | > text |
| 无序列表 | - item |
| 有序列表 | 1. item |
| 任务列表 | - [ ] task / - [x] done |
| 提示 | > [!NOTE] / [!TIP] / [!WARNING] / [!IMPORTANT] / [!CAUTION] |
| 脚注 | text[^1] … [^1]: note |
| 提及 | @user / @org/team |
| 问题引用 | #42 |
| 表情符号 | :tada: |
| 转义 | \*literal\* |
| 评论 | |
按需阅读
| 阅读时机 | 文件 |
|---|---|
| 查询任意 GFM 功能的单行语法 | 快速参考 |
| 标题、文本样式、代码块、换行、转义 | 文本与标题 |
| 链接(行内、章节、相对路径、自定义锚点)、图片 | 链接与图片 |
| 有序/无序列表、嵌套、任务列表 | 列表与任务 |
| 提示、脚注、提及、表情符号 | 提示、脚注与提及 |
常见陷阱
.md文件中的换行需要两个尾随空格、一个\或<br/>— 单纯换行不会断行。- 嵌套列表的缩进必须在视觉上让子项标记与父项第一个文本字符对齐。
- 分节锚点的生成规则:转为小写,空格替换为
-,去除所有其他标点。重复标题会添加-1、-2后缀 — 如果调整标题顺序,请更新相应链接。 - 警示内容不能嵌套在其他元素中,并且应谨慎使用。
- GitHub Wiki 不支持脚注。
- 颜色样本(
`#hex`,`rgb()`,`hsl()`)仅会在议题、PR 和讨论中渲染 — 不会在普通.md文件视图中渲染。 - 自定义锚点(
<a name="">)不会包含在自动生成的目录中。
基准测试
场景:.benchmarks/scenarios/markdown-001-wiki-limits.md · 运行日期:2026-08-31 · 日志:.benchmarks/runs/2026-08-31/markdown-001-wiki-limits.json
| 模型 | 不使用 | 使用 | 差值 |
|---|---|---|---|
| claude-opus-4-8 | 100% | 100% | +0% |
| claude-sonnet-4-6 | 100% | 100% | +0% |
| claude-haiku-4-5 | 80% | 100% | +20% |
软性通过(运行日期:2026-08-31)。Haiku +20(80→100);opus/sonnet 已达上限。门槛见
.agents/skills/skill-optimizer/rules/release-gates.md。
评论
支持 Markdown