Markdown Coding Style Guide

Markdown 语法说明 (简体中文版)
Markdown 书写风格指南

文件扩展名

使用更短更流行的.md，而不是.mkd或.markdown

文件名

小写，用连字符代替空格，例如file-name.md

空行

不同元素间空一行。文本的段落之间空一行。

#### 标题

内容

#### 标题

内容

行内代码块

使用行内代码块标记文件路径，类名，方法名等相关内容。

内容

英文与中文间空一格

标题

#和内容之间空一格，不使用闭合的#标记，尽量不越级使用。不需要在标题最后加入标点符号。

# 标题 1

## 标题 2

### 标题 3

引用

'>'和内容之间空一格，每一行都使用'>'。

> Long line
>
> that was wrapped.

列表

无序列表使用连字符'-'，不建议使用'*'，因为容易和加粗混淆，不使用'+'是因为不流行。在有序和无序中优先使用无序列表，如果使用有序列表的话，则仅仅使用1.，这种情况下，既可以正确展示顺序，并且在列表中增加或删除列表项都比较方便。

1. a
1. b
1. c

列表项的内容前统一空一格。换行内容与第一行对齐。列表项之间不空行。标点符号视情况而定，如果成句或成段的话，可以加标点符号。

代码块

使用'```'包含多行代码，这样最外层代码不需要缩进，而且可以指明语言。

```ruby
a = 1

水平横线

使用3个连续的连字符表示---

强调

使用双星号表示加粗**bold**，使用单星号表示斜体*italic*，因为相比下划线可读性更高。

表格

用 | 包裹表格的每一行。竖直对齐所有表格边框。将标题和内容用连字符分割。| 周围必须要有一个空格。列的宽度通过列中最长的单元格确定。

| header | Long header |
|--------|-------------|
| abc    | def         |
| abc2   | def2        |