格式规范 #

好的：
# 一级标题（文档标题，唯一）
## 二级标题（章节）
### 三级标题（小节）
#### 四级标题（段落）

不好的：
# 标题一
### 直接跳到三级（跳级）

好的：
## 标题

内容...

## 下一个标题

不好的：
## 标题
内容...
## 下一个标题

好的：
# 文档标题

内容...

## 章节1

内容...

不好的：
# 标题1
# 标题2（多个一级标题）

好的：
第一段内容。

第二段内容。

不好的：
第一段内容。
第二段内容。

好的：
建议每行不超过 80 字符，
长段落可以手动换行，
保持源码可读性。

不好的：
这是一个非常非常长的段落，建议手动换行以提高源码可读性...

好的：
- 项目一
- 项目二
- 项目三

不好的：
- 项目一
* 项目二
+ 项目三

好的：
段落内容。

- 列表项一
- 列表项二

更多内容。

不好的：
段落内容。
- 列表项一
- 列表项二
更多内容。

好的：
- 一级
  - 二级
    - 三级

不好的：
- 一级
  - 二级
   - 三级（缩进不一致）

好的：
```javascript
const x = 1;

const x = 1;

### 代码块前后空行

```markdown
好的：
说明文字...

```javascript
const x = 1;

const x = 1;

## 链接规范

### 使用描述性文本

```markdown
好的：
查看 [官方文档](https://example.com)

不好的：
点击 [这里](https://example.com)

好的：
正文中的链接 [GitHub][gh]

<!-- 链接定义 -->
[gh]: https://github.com

不好的：
正文中的链接 [GitHub](https://github.com)

好的：
![用户登录界面截图](login.png)

不好的：
![图片](1.png)

docs/
├── images/
│   ├── screenshots/
│   └── diagrams/
└── README.md

好的：
| 文本 | 数字 |
|:------|-----:|
| 左对齐 | 右对齐 |

不好的：
| 文本 | 数字 |
|-------|-------|
| 无对齐 | 无对齐 |

好的：
| 列1 | 列2 |
|-----|-----|
| A | B |

不好的：
过于复杂的表格，考虑使用列表

好的：
内容

不好的：
内容（行尾有空格）

好的：
段落一

段落二

不好的：
段落一



段落二（多个空行）

{
  "proseWrap": "always",
  "tabWidth": 2
}

{
  "default": true,
  "MD013": false
}