markdown-accessibility

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Markdown Accessibility Skill

Markdown无障碍技能

Reusable knowledge module for the
markdown-a11y-assistant
,
markdown-scanner
, and
markdown-fixer
agents and the
markdown-accessibility
always-on instructions. Provides pattern libraries, severity scoring, fix templates, emoji translation maps, diagram description templates, and GitHub anchor generation rules for comprehensive markdown accessibility auditing across 9 domains.
这是供
markdown-a11y-assistant
markdown-scanner
markdown-fixer
Agent以及
markdown-accessibility
常驻指令使用的可复用知识模块,提供模式库、严重程度评分、修复模板、emoji翻译映射表、图表描述模板和GitHub锚点生成规则,可覆盖9个领域的完整Markdown无障碍审计能力。

Domains Covered

覆盖领域

  1. Descriptive Links (WCAG 2.4.4) - Ambiguous link text, bare URLs, repeated identical text
  2. Image Alt Text (WCAG 1.1.1) - Missing, empty, filename-as-alt, generic placeholders
  3. Heading Hierarchy (WCAG 1.3.1 / 2.4.6) - Skipped levels, multiple H1s, bold-as-heading
  4. Table Accessibility (WCAG 1.3.1) - Missing descriptions, empty headers, layout tables
  5. Emoji (WCAG 1.3.3 / Cognitive) - Remove-all, remove-decorative, translate, or leave-unchanged modes
  6. Mermaid and ASCII Diagrams (WCAG 1.1.1 / 1.3.1) - Replace with accessible text + collapsible source
  7. Em-Dash / En-Dash Normalization (Cognitive) - Normalize to
    -
    or leave unchanged
  8. Anchor Link Validation (WCAG 2.4.4) - Validate
    #anchor
    links against actual headings
  9. Plain Language and List Structure (Cognitive) - Emoji bullets, passive voice, sentence length
  1. 描述性链接(WCAG 2.4.4)- 模糊链接文本、裸URL、重复的相同链接文本
  2. 图片替代文本(WCAG 1.1.1)- 缺失、空值、文件名作为替代文本、通用占位符
  3. 标题层级(WCAG 1.3.1 / 2.4.6)- 跳过层级、多个H1、使用粗体代替标题
  4. 表格无障碍(WCAG 1.3.1)- 缺失描述、空表头、布局用表格
  5. Emoji(WCAG 1.3.3 / 认知)- 全部移除、移除装饰性emoji、翻译、保持不变四种模式
  6. Mermaid和ASCII图表(WCAG 1.1.1 / 1.3.1)- 替换为无障碍文本+可折叠源码
  7. 长破折号/短破折号标准化(认知)- 统一为
    -
    或保持不变
  8. 锚点链接验证(WCAG 2.4.4)- 对照实际标题校验
    #anchor
    链接的有效性
  9. 通俗语言与列表结构(认知)- Emoji项目符号、被动语态、句子长度

Severity Scoring

严重程度评分

IssueSeverityWCAGAuto-fix?
Image missing alt textCritical1.1.1 (A)No - needs visual judgment
Mermaid diagram with no text alternativeCritical1.1.1 (A)Partial - simple diagrams auto-described; complex need human
ASCII diagram with no text descriptionCritical1.1.1 (A)Partial - flag and wrap; description needs human or auto-gen
Broken anchor linkSerious2.4.4 (A)No - confirm which end changes
Ambiguous link text ("here", "click here")Serious2.4.4 (A)Yes - rewrite using surrounding context
Skipped heading levelSerious1.3.1 (A)Yes - interpolate missing level
Multiple H1sSerious1.3.1 (A)Yes - demote all but first
Emoji in headingModerateCognitiveYes - remove or translate per preference
Consecutive emoji (2+)Moderate1.3.3 (A)Yes - remove sequence or translate
Emoji used as bulletModerate1.3.1 (A)Yes - replace with
-
Em-dash in proseModerateCognitiveYes - replace with
-
Table without preceding descriptionModerate1.3.1 (A)Yes - add one-sentence summary
Bold text used as headingMinor2.4.6 (AA)Yes - convert to appropriate heading
Bare URL in proseMinor2.4.4 (A)Yes - wrap with descriptive text
Emoji used for meaning, single inlineMinor1.3.3 (A)Conditional - remove-all: yes; remove-decorative: flag; translate: translate
问题严重程度WCAG可自动修复?
图片缺失替代文本危急1.1.1 (A)否 - 需要视觉判断
Mermaid图表没有文本替代危急1.1.1 (A)部分 - 简单图表可自动生成描述;复杂图表需要人工处理
ASCII图表没有文本描述危急1.1.1 (A)部分 - 标记并包裹内容;描述需要人工生成或自动生成
锚点链接损坏严重2.4.4 (A)否 - 需要确认哪一端需要修改
模糊链接文本("here"、"click here")严重2.4.4 (A)是 - 结合上下文重写
标题层级跳过严重1.3.1 (A)是 - 补全缺失的层级
多个H1标题严重1.3.1 (A)是 - 降级除第一个之外的所有H1
标题中包含Emoji中等认知是 - 按偏好移除或翻译
连续Emoji(2个及以上)中等1.3.3 (A)是 - 移除序列或翻译
使用Emoji作为项目符号中等1.3.1 (A)是 - 替换为
-
正文中的长破折号中等认知是 - 替换为
-
表格没有前置描述中等1.3.1 (A)是 - 添加一句话总结
使用粗体文本作为标题轻微2.4.6 (AA)是 - 转换为合适的标题层级
正文中的裸URL轻微2.4.4 (A)是 - 用描述性文本包裹
单个行内表意Emoji轻微1.3.3 (A)视情况而定:全部移除模式下可自动修复;移除装饰性模式下标记;翻译模式下自动翻译

Scoring Formula

评分公式

text
File Score = 100 - (sum of weighted findings)

Critical: -15 pts each
Serious:  - 7 pts each
Moderate: - 3 pts each
Minor:    - 1 pt each

Floor: 0
text
文件得分 = 100 - (加权问题总和)

危急:每个扣15分
严重:每个扣7分
中等:每个扣3分
轻微:每个扣1分

最低分:0

Score Grades

评分等级

ScoreGradeMeaning
90-100AExcellent - accessible documentation
75-89BGood - minor issues
50-74CNeeds Work - several barriers
25-49DPoor - significant barriers
0-24FFailing - critical AT barriers
得分等级含义
90-100A优秀 - 无障碍适配完善的文档
75-89B良好 - 存在轻微问题
50-74C需要优化 - 存在多处访问障碍
25-49D较差 - 存在明显访问障碍
0-24F未通过 - 存在辅助技术访问的致命障碍

Emoji Handling Modes

Emoji处理模式

The agent supports four modes configured during Phase 0:
ModeDescriptionDefault?
remove-all
Strip every emoji from prose, headings, and bulletsNo
remove-decorative
Remove emoji in headings, bullets, and consecutive sequences; flag single inline for reviewYes (default)
translate
Replace known emoji with
(English)
text; flag unknown for review
No
leave-unchanged
Do not flag or modify any emojiNo
Agent支持在第0阶段配置的四种模式:
模式描述是否默认?
remove-all
移除正文、标题和项目符号中的所有emoji
remove-decorative
移除标题、项目符号和连续序列中的emoji;标记单个行内emoji供审核是(默认)
translate
将已知emoji替换为
(英文)
文本;标记未知emoji供审核
leave-unchanged
不标记也不修改任何emoji

Emoji Translation Map

Emoji翻译映射表

When using
translate
mode, replace each emoji with the parenthesized English equivalent:
EmojiTranslationEmojiTranslation
🚀(Launch)(Done)
⚠️(Warning)(Error)
📝(Note)💡(Tip)
🔧(Configuration)📚(Documentation)
🎯(Goal)(New)
🔍(Search)🛠️(Tools)
👋(Hello)🎉(Celebration)
(Featured)💬(Discussion)
🏠(Home)📊(Data)
🔒(Security)🌐(Web)
📦(Package)🔗(Link)
📋(Checklist)🏆(Achievement)
(Quick)👍(Approved)
👎(Rejected)🐛(Bug)
🤝(Collaboration)🎓(Learning)
🔑(Key)📌(Pinned)
ℹ️(Info)🔄(Refresh)
(Add)(Remove)
💻(Code)🔔(Notification)
📣(Announcement)🧪(Test)
🎨(Design)🌟(Highlight)
📈(Increase)📉(Decrease)
🏗️(Build)🔐(Locked)
📂(Folder)📁(Folder)
🗂️(Category)🗃️(Archive)
⚙️(Settings)🏁(Finish)
🚧(In Progress)🚫(Not Allowed)
✔️(Check)➡️(Next)
⬆️(Up)⬇️(Down)
For emoji not in this table: flag as
needs-human-review
. Do not guess.
使用
translate
模式时,将每个emoji替换为括号内的英文对等表述:
Emoji翻译Emoji翻译
🚀(Launch)(Done)
⚠️(Warning)(Error)
📝(Note)💡(Tip)
🔧(Configuration)📚(Documentation)
🎯(Goal)(New)
🔍(Search)🛠️(Tools)
👋(Hello)🎉(Celebration)
(Featured)💬(Discussion)
🏠(Home)📊(Data)
🔒(Security)🌐(Web)
📦(Package)🔗(Link)
📋(Checklist)🏆(Achievement)
(Quick)👍(Approved)
👎(Rejected)🐛(Bug)
🤝(Collaboration)🎓(Learning)
🔑(Key)📌(Pinned)
ℹ️(Info)🔄(Refresh)
(Add)(Remove)
💻(Code)🔔(Notification)
📣(Announcement)🧪(Test)
🎨(Design)🌟(Highlight)
📈(Increase)📉(Decrease)
🏗️(Build)🔐(Locked)
📂(Folder)📁(Folder)
🗂️(Category)🗃️(Archive)
⚙️(Settings)🏁(Finish)
🚧(In Progress)🚫(Not Allowed)
✔️(Check)➡️(Next)
⬆️(Up)⬇️(Down)
不在本表中的emoji:标记为
needs-human-review
,不要猜测含义。

Emoji Detection Unicode Ranges

Emoji检测Unicode范围

[\u{1F600}-\u{1F64F}]  - Emoticons
[\u{1F300}-\u{1F5FF}]  - Misc symbols and pictographs
[\u{1F680}-\u{1F6FF}]  - Transport and map symbols
[\u{1F700}-\u{1F77F}]  - Alchemical symbols
[\u{1F780}-\u{1F7FF}]  - Geometric shapes extended
[\u{1F900}-\u{1F9FF}]  - Supplemental symbols
[\u{1FA70}-\u{1FAFF}]  - Symbols and pictographs extended
[\u{2600}-\u{26FF}]    - Misc symbols
[\u{2700}-\u{27BF}]    - Dingbats
[\u{1F1E0}-\u{1F1FF}]  - Flags
[\u{FE00}-\u{FE0F}]    - Variation selectors
Emoji-as-bullet pattern: list item where the first non-whitespace character is an emoji.
[\u{1F600}-\u{1F64F}]  - 表情符号
[\u{1F300}-\u{1F5FF}]  - 杂项符号和象形图
[\u{1F680}-\u{1F6FF}]  - 交通和地图符号
[\u{1F700}-\u{1F77F}]  - 炼金术符号
[\u{1F780}-\u{1F7FF}]  - 扩展几何形状
[\u{1F900}-\u{1F9FF}]  - 补充符号
[\u{1FA70}-\u{1FAFF}]  - 扩展符号和象形图
[\u{2600}-\u{26FF}]    - 杂项符号
[\u{2700}-\u{27BF}]    - 丁巴特符号
[\u{1F1E0}-\u{1F1FF}]  - 旗帜
[\u{FE00}-\u{FE0F}]    - 变体选择器
Emoji作为项目符号的模式:列表项的第一个非空白字符为emoji。

Pattern Library: Mermaid and ASCII Diagrams

模式库:Mermaid和ASCII图表

Mermaid Detection

Mermaid检测

Lines matching
 ```mermaid
(with optional leading spaces/tabs).
匹配
 ```mermaid
格式的行(允许前导空格/制表符)。

Mermaid Description Templates

Mermaid描述模板

TypeDescription Template
graph TD/LR/RL/BT
/
flowchart
"The following [direction] diagram shows: [list major nodes and connections from source]"
sequenceDiagram
"The following sequence diagram shows the interaction between [participants]: [list each message in order]"
classDiagram
"The following class diagram shows [N] classes: [list class names, key properties, and relationships]"
erDiagram
"The following entity-relationship diagram shows [entities] with these relationships: [list relationships]"
gantt
"The following Gantt chart shows project tasks: [list section names and tasks with dates if available]"
pie
"The following pie chart shows [title] with values: [list each label and percentage/value if available]"
stateDiagram
"The following state diagram shows [N] states: [list state names and transition triggers]"
mindmap
"The following mind map shows [root topic] with branches: [list top-level branch names]"
timeline
"The following timeline shows events: [list events in chronological order]"
Auto-generate description for:
graph
,
flowchart
,
pie
,
gantt
,
mindmap
,
timeline
. Flag for human review:
sequenceDiagram
,
classDiagram
,
erDiagram
,
stateDiagram
(complex enough to need human verification).
类型描述模板
graph TD/LR/RL/BT
/
flowchart
"以下[方向]图表展示:[列出来源中的主要节点和连接]"
sequenceDiagram
"以下序列图展示了[参与者]之间的交互:[按顺序列出每条消息]"
classDiagram
"以下类图展示了[N]个类:[列出类名、核心属性和关系]"
erDiagram
"以下实体关系图展示了[实体]及对应关系:[列出关系]"
gantt
"以下甘特图展示了项目任务:[列出分区名称和任务(若有日期也一并列出)]"
pie
"以下饼图展示了[标题]对应数值:[列出每个标签和百分比/数值(若有)]"
stateDiagram
"以下状态图展示了[N]个状态:[列出状态名和转换触发条件]"
mindmap
"以下思维导图展示了[根主题]及分支:[列出顶层分支名称]"
timeline
"以下时间线展示了相关事件:[按时间顺序列出事件]"
支持自动生成描述的类型:
graph
flowchart
pie
gantt
mindmap
timeline
。 需要标记供人工审核的类型:
sequenceDiagram
classDiagram
erDiagram
stateDiagram
(复杂度较高,需要人工验证)。

Mermaid Replacement Template

Mermaid替换模板

markdown
[Generated or user-provided text description - this is the primary accessible content]

<details>
<summary>Diagram source (Mermaid)</summary>

```mermaid
[original diagram source - unchanged]
</details> ```
markdown
[自动生成或用户提供的文本描述 - 这是核心无障碍内容]

<details>
<summary>图表源码(Mermaid)</summary>

```mermaid
[原始图表源码 - 保持不变]
</details> ```

ASCII Diagram Detection

ASCII图表检测

ASCII art patterns: non-code-block lines (or unnamed code blocks) containing combinations of
+
,
-
,
|
,
/
,
\
,
>
,
<
,
^
,
v
,
*
forming a visual structure. Minimum 3 lines with consistent column alignment.
ASCII艺术模式:非代码块行(或未命名代码块)包含
+
-
|
/
\
>
<
^
v
*
的组合,构成可视化结构,至少3行且列对齐一致。

ASCII Diagram Replacement Template

ASCII图表替换模板

markdown
[Generated or user-provided text description - this is the primary accessible content]

<details>
<summary>ASCII diagram</summary>
[original ASCII art - unchanged]

</details>
markdown
[自动生成或用户提供的文本描述 - 这是核心无障碍内容]

<details>
<summary>ASCII图表</summary>
[原始ASCII艺术 - 保持不变]

</details>

Pattern Library: Ambiguous Link Detection

模式库:模糊链接检测

Match these patterns (case-insensitive, trim whitespace):
匹配以下模式(不区分大小写,修剪空白字符):

Exact-match violations

精确匹配违规项

here, click here, read more, learn more, more, more info,
link, details, info, go, see more, continue, start, download,
view, open, submit, this, that
here, click here, read more, learn more, more, more info,
link, details, info, go, see more, continue, start, download,
view, open, submit, this, that

Starts-with violations

开头匹配违规项

click here to ..., read more about ..., learn more about ...,
here to ..., see more ...
click here to ..., read more about ..., learn more about ...,
here to ..., see more ...

URL-as-text pattern

URL作为文本模式

Any link where visible text matches
https?://
or
www\.
任何可见文本匹配
https?://
www\.
的链接。

Repeated identical text

重复相同文本

Multiple
[X](url1)
and
[X](url2)
with same X but different URLs on the same page.
同一页面中存在多个
[X](url1)
[X](url2)
,X相同但URL不同。

Safe patterns (do not flag)

安全模式(不标记)

  • Badge links:
    [![text](img)](url)
    at top of README
  • Section self-references:
    [Installation](#installation)
    where text matches heading
  • Footer resource lists using the resource/tool name as text
  • 徽章链接:README顶部的
    [![text](img)](url)
  • 章节自引用:
    [Installation](#installation)
    ,文本与标题匹配
  • 页脚资源列表,使用资源/工具名称作为链接文本

Pattern Library: GitHub Anchor Generation

模式库:GitHub锚点生成

GitHub converts headings to anchor IDs using these rules:
  1. Lowercase entire string
  2. Remove all characters except: letters (a-z), digits (0-9), spaces, hyphens
  3. Replace spaces with hyphens
  4. Remove leading and trailing hyphens
GitHub通过以下规则将标题转换为锚点ID:
  1. 整个字符串转为小写
  2. 移除所有字符,仅保留:字母(a-z)、数字(0-9)、空格、连字符
  3. 将空格替换为连字符
  4. 移除首尾的连字符

Examples

示例

HeadingAnchor
# Getting Started
#getting-started
## API: v2.0 Reference
#api-v20-reference
### What's New?
#whats-new
## C# and .NET Support
#c-and-net-support
## Step 1: Installation
#step-1-installation
## FAQ (Frequently Asked Questions)
#faq-frequently-asked-questions
## 🚀 Quick Start
#-quick-start
(emoji becomes empty, may vary)
For headings containing emoji: GitHub strips the emoji character and generates an anchor from the remaining text. Anchors referencing emoji-containing headings are fragile and should be flagged.
标题锚点
# Getting Started
#getting-started
## API: v2.0 Reference
#api-v20-reference
### What's New?
#whats-new
## C# and .NET Support
#c-and-net-support
## Step 1: Installation
#step-1-installation
## FAQ (Frequently Asked Questions)
#faq-frequently-asked-questions
## 🚀 Quick Start
#-quick-start
(emoji变为空,可能存在差异)
包含emoji的标题:GitHub会移除emoji字符,基于剩余文本生成锚点。引用包含emoji标题的锚点稳定性较差,应当标记。

Pattern Library: Emoji Detection

模式库:Emoji检测

Unicode emoji ranges for regex detection:
[\u{1F600}-\u{1F64F}]  # Emoticons
[\u{1F300}-\u{1F5FF}]  # Misc symbols and pictographs
[\u{1F680}-\u{1F6FF}]  # Transport and map symbols
[\u{1F700}-\u{1F77F}]  # Alchemical symbols
[\u{1F780}-\u{1F7FF}]  # Geometric shapes extended
[\u{1F800}-\u{1F8FF}]  # Supplemental arrows-C
[\u{1F900}-\u{1F9FF}]  # Supplemental symbols and pictographs
[\u{1FA00}-\u{1FA6F}]  # Chess symbols
[\u{1FA70}-\u{1FAFF}]  # Symbols and pictographs extended-A
[\u{2600}-\u{26FF}]    # Misc symbols
[\u{2700}-\u{27BF}]    # Dingbats
[\u{FE00}-\u{FE0F}]    # Variation selectors
[\u{1F1E0}-\u{1F1FF}]  # Flags
Emoji-as-bullet pattern: List item where first non-whitespace character is an emoji.
用于正则检测的Unicode emoji范围:
[\u{1F600}-\u{1F64F}]  # 表情符号
[\u{1F300}-\u{1F5FF}]  # 杂项符号和象形图
[\u{1F680}-\u{1F6FF}]  # 交通和地图符号
[\u{1F700}-\u{1F77F}]  # 炼金术符号
[\u{1F780}-\u{1F7FF}]  # 扩展几何形状
[\u{1F800}-\u{1F8FF}]  # 补充箭头-C
[\u{1F900}-\u{1F9FF}]  # 补充符号和象形图
[\u{1FA00}-\u{1FA6F}]  # 国际象棋符号
[\u{1FA70}-\u{1FAFF}]  # 扩展符号和象形图-A
[\u{2600}-\u{26FF}]    # 杂项符号
[\u{2700}-\u{27BF}]    # 丁巴特符号
[\u{FE00}-\u{FE0F}]    # 变体选择器
[\u{1F1E0}-\u{1F1FF}]  # 旗帜
Emoji作为项目符号的模式:列表项的第一个非空白字符为emoji。

Pattern Library: Em-Dash and En-Dash

模式库:长破折号和短破折号

Detection patterns:
—           Unicode em-dash (U+2014)
–           Unicode en-dash (U+2013)
---         Three hyphens in prose (not on its own line as HR)
--          Two hyphens in prose (used as em-dash substitute)
Safe to skip (do not modify):
  • Line containing only
    ---
    (horizontal rule)
  • Content inside
    ```
    code fences
  • Content inside backtick inline code
  • YAML front matter block
  • HTML comment blocks
    <!-- -->
Replacement:
-
(space + hyphen + space)
En-dash in numeric ranges:
2–4 hours
->
2 - 4 hours
检测模式:
—           Unicode长破折号(U+2014)
–           Unicode短破折号(U+2013)
---         正文中的三个连字符(不是单独成行的水平分隔线)
--          正文中的两个连字符(用作长破折号替代)
可跳过的安全场景(不修改):
  • 仅包含
    ---
    的行(水平分隔线)
  • undefined
  • 反引号包裹的行内代码内容
  • YAML前置元数据块
  • HTML注释块
    <!-- -->
替换为:
-
(空格+连字符+空格)
数字范围中的短破折号:
2–4 hours
->
2 - 4 hours

Pattern Library: Mermaid Diagrams

模式库:Mermaid图表

Detection: Lines matching
 ```mermaid
(with optional leading spaces/tabs)
Diagram types and description guidance:
TypeDescription Template
graph TD/LR/RL/BT
"The following diagram shows a [direction] flowchart: [list major nodes and connections]"
sequenceDiagram
"The following sequence diagram shows the interaction between [participants]: [list message exchanges]"
classDiagram
"The following class diagram shows [N] classes: [list class names and key relationships]"
erDiagram
"The following entity-relationship diagram shows [entities] and their relationships: [list relationships]"
gantt
"The following Gantt chart shows project phases: [list tasks and timeframes]"
pie
"The following pie chart shows [title] with values: [list segment names and values if available]"
stateDiagram
"The following state diagram shows [N] states and transitions: [list states and transition triggers]"
Wrapping template:
markdown
[Generated or user-provided text description]

<details>
<summary>Diagram source (Mermaid)</summary>

```mermaid
[original diagram source]
</details> ```
检测:匹配
 ```mermaid
格式的行(允许前导空格/制表符)
图表类型和描述指南:
类型描述模板
graph TD/LR/RL/BT
"以下图表展示了一个[方向]流程图:[列出主要节点和连接]"
sequenceDiagram
"以下序列图展示了[参与者]之间的交互:[列出消息交互]"
classDiagram
"以下类图展示了[N]个类:[列出类名和核心关系]"
erDiagram
"以下实体关系图展示了[实体]及其关系:[列出关系]"
gantt
"以下甘特图展示了项目阶段:[列出任务和时间范围]"
pie
"以下饼图展示了[标题]对应数值:[列出分段名称和数值(若有)]"
stateDiagram
"以下状态图展示了[N]个状态和转换:[列出状态和转换触发条件]"
包裹模板:
markdown
[自动生成或用户提供的文本描述]

<details>
<summary>图表源码(Mermaid)</summary>

```mermaid
[原始图表源码]
</details> ```

Fix Templates

修复模板

Ambiguous link fix

模糊链接修复

markdown
undefined
markdown
undefined

Before

修复前

For more information, see here.
For more information, see here.

After

修复后

For more information, see the installation guide.
undefined
For more information, see the installation guide.
undefined

Emoji bullet fix

Emoji项目符号修复

markdown
undefined
markdown
undefined

Before

修复前

  • 🚀 Deploy to production
  • ✅ Run tests
  • 🚀 Deploy to production
  • ✅ Run tests

After

修复后

  • Deploy to production
  • Run tests
undefined
  • Deploy to production
  • Run tests
undefined

Emoji heading fix

Emoji标题修复

markdown
undefined
markdown
undefined

Before

修复前

🔧 Configuration

🔧 Configuration

After

修复后

Configuration

Configuration

undefined
undefined

Em-dash fix

长破折号修复

markdown
undefined
markdown
undefined

Before

修复前

The agent—when invoked—will scan all files.
The agent—when invoked—will scan all files.

After

修复后

The agent - when invoked - will scan all files.
undefined
The agent - when invoked - will scan all files.
undefined

Table description fix

表格描述修复

markdown
undefined
markdown
undefined

Before

修复前

RuleSeverityAuto-fix
RuleSeverityAuto-fix

After

修复后

The following table lists rules with their severity level and whether they can be fixed automatically.
RuleSeverityAuto-fix
undefined
The following table lists rules with their severity level and whether they can be fixed automatically.
RuleSeverityAuto-fix
undefined

Broken anchor fix

损坏锚点修复

markdown
undefined
markdown
undefined

Before (broken)

修复前(损坏)

See Installation for setup steps.
See Installation for setup steps.

Heading in file

文件中的标题

Installation

Installation

After (corrected)

修复后(已校正)

See Installation for setup steps.
undefined
See Installation for setup steps.
undefined

Markdownlint Rules Reference

Markdownlint规则参考

RuleNameAccessibility Relevance
MD001heading-incrementHeading hierarchy (WCAG 1.3.1)
MD022blanks-around-headingsParsing reliability
MD024no-duplicate-headingUnique section identity (WCAG 2.4.6)
MD025single-title / single-h1One H1 per document
MD033no-inline-htmlMay hide structure from parsers
MD034no-bare-urlsAmbiguous links (WCAG 2.4.4)
MD041first-line-headingDocument structure
MD055table-pipe-styleTable parsing consistency
MD056table-column-countTable structural integrity
Command:
npx --yes markdownlint-cli2 <filepath>
规则名称无障碍相关性
MD001heading-increment标题层级(WCAG 1.3.1)
MD022blanks-around-headings解析可靠性
MD024no-duplicate-heading唯一章节标识(WCAG 2.4.6)
MD025single-title / single-h1每个文档仅一个H1
MD033no-inline-html可能对解析器隐藏结构
MD034no-bare-urls模糊链接(WCAG 2.4.4)
MD041first-line-heading文档结构
MD055table-pipe-style表格解析一致性
MD056table-column-count表格结构完整性
命令:
npx --yes markdownlint-cli2 <filepath>