Markdown 核心规范

Markdown 核心规范

相关 Skills

• Skills(markdown:mermaid) - Mermaid 图表（流程图、序列图、类图、ER 图）
• Skills(naming:core) - 命名规范（文件名、标题命名）

Red Flags：AI 常见误区

AI 可能的理性化解释	实际应该检查的内容
"代码块不需要语言标记"	✅ 是否所有代码块都指定了语言？
"标题跳级没关系"	✅ 是否标题层级连续（# → ## → ###）？
"链接文字随便写"	✅ 链接文字是否描述了目标内容？
"段落长一点更完整"	✅ 每段是否控制在 5 句以内？
"不需要 alt 文本"	✅ 所有图片是否有 alt 描述？

核心原则

Markdown 文档编写追求清晰、简洁、结构化。

必须遵守

1. UTF-8 编码 - 文件使用 UTF-8 编码
2. 一级标题 - 每个文件仅一个
3. 标题层级 - 不跳级（# → ## → ###）
4. 代码块 - 必须指定语言标记
5. 链接 - 链接文字必须描述目标内容
6. 图片 - 必须包含 alt 文本
7. 表格 - 必须有表头行

禁止行为

• 标题层级跳跃
• 代码块无语言标记
• 链接文字为"点击这里"
• 图片无 alt 文本
• 过长的段落（>5 句）
• 表格缺少表头

文档结构

# 文档标题

简介/摘要

## 主要章节

### 子章节

#### 详细内容

## 参考资料

## 版本信息

格式规范

标题

# 一级标题（文档标题，仅一个）

## 二级标题（主要章节）

### 三级标题（子章节）

#### 四级标题（详细内容）

代码块

```python
def hello():
    print("Hello, World!")
```

链接和图片

[链接描述](https://example.com)

![图片描述](./images/example.png)

表格

| 列1  | 列2  | 列3  |
| ---- | ---- | ---- |
| 内容 | 内容 | 内容 |

检查清单

• 文件使用 UTF-8 编码
• 一级标题仅一个
• 标题层级不跳级
• 代码块有语言标记
• 链接有描述文字
• 图片有 alt 文本
• 表格有表头