风格指南 #

推荐：
getting-started.md
api-reference.md
configuration.md

不推荐：
Getting Started.md
API Reference.md

推荐：
user-login-screenshot.png
system-architecture-diagram.png

不推荐：
1.png
image.png

推荐：
## Getting Started
## API Reference

不推荐：
## Getting started
## api reference

推荐：
# 文档标题
## 章节
### 小节

不推荐：
# 文档标题
### 直接跳到小节

推荐：
- 项目一
- 项目二
- 项目三

不推荐：
* 项目一
+ 项目二
- 项目三

推荐：
1. 项目一
1. 项目二
1. 项目三

不推荐：
1. 项目一
2. 项目二
3. 项目三

推荐：
```javascript
const greeting = 'Hello, World!';

const greeting = 'Hello, World!';

### 行内代码

```markdown
推荐：
使用 `npm install` 安装依赖

不推荐：
使用 npm install 安装依赖

推荐：
查看 [官方文档](https://example.com)

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

推荐：
[GitHub][gh]

[gh]: https://github.com

不推荐：
[GitHub](https://github.com)

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

不推荐：
![图片](login.png)

推荐：
<img src="image.png" width="600">

不推荐：
![图片](image.png)（无尺寸控制）

推荐：
| 名称 | 数量 |
|:------|-----:|
| A | 100 |

不推荐：
| 名称 | 数量 |
|-------|-------|
| A | 100 |

推荐：
简单表格

不推荐：
过于复杂的表格

推荐：
段落一

段落二

不推荐：
段落一
段落二

推荐：
内容（无行尾空格）

不推荐：
内容（有行尾空格）

推荐：
**重要内容**

不推荐：
__重要内容__

推荐：
*强调内容*

不推荐：
_强调内容_

推荐：
> 引用内容

不推荐：
>引用内容（无空格）

推荐：
---

不推荐：
***
___

{
  "default": true,
  "MD003": { "style": "atx" },
  "MD004": { "style": "dash" },
  "MD007": { "indent": 2 },
  "MD013": false,
  "MD033": false
}

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