Markdown 入门手册 - logan676/seadroid GitHub Wiki
| 功能 | 效果 | Markdown代码 | 备注 | 
|---|---|---|---|
| 粗体 | 粗体 | **粗体** | 两边加** | 
| 斜体 | 斜体 | _斜体_ | 两边加_ | 
| 中划线 | ~~中划线~~ | 两边加~~ | |
| 单行代码 | Log.i("Hello World!") | `Log.i("Hello World!")` | 两边加` | 
| 插入图片 |  |  | [] 中间为占位符,() 中间为图片链接 | 
| 链接 | Visit Github | [Visit Github](http://www.github.com) | [] 中间为显示文字,() 中间为链接 | 
在需要换行的地方敲击两次空格和一个回车键即可,如:
这是第一行(空格)(空格)(回车)
这是第二行
Tip: 多条新行都会被视为一行
Markdown 提供了六种规格的标题,分别对应 Html 标签中的<h1>-<h6>,通过添加不同数量的#字符可以实现不同大小的标题,如:
# 最大的标题(相当于一个<h1>标签)
## 次大的标题(相当于一个<h2>标签)
...
###### 最小的标题(相当于一个<h6>标签)
Tip: # 越多,标题越小
数字 + . + 空格即可,以下代码:
1. 项目1  
2. 项目2  
3. 项目3  
效果为:
- 项目1
- 项目2
- 项目3
以 * 和空格开头即可,以下代码:
* 项目1
* 项目2
* 项目3
效果为:
- 项目1
- 项目2
- 项目3
子项目缩进一个 tab 并加 * 和 空格表示,以下代码:
* 项目1
    * 子项目1
    * 子项目2
* 项目2
    * 子项目1
效果为:
- 项目1
- 子项目1
- 子项目2
 
- 项目2
- 子项目1
 
以 ``` 和 ``` 包含,以下代码:
```
def hello():
    print 'Hello World!'
```
效果为:
def hello():
    print 'Hello World!'
GFM 扩展了 Markdown 的代码块功能,通过在上面第一个 ``` 后添加语言名称,使不同语言展现不同的代码高亮风格,以下代码:
```java
public static void main(String[] args){
    System.out.println("Hello World!");
}
```
效果为:
public static void main(String[] args){
    System.out.println("Hello World!");
}以下代码:
```python
def hello():
    print 'Hello World!'
```
效果为:
def hello():
    print 'Hello World!'标准的 Markdown 中并不支持表格,但 GFM 可以,表头前空一行,以 ---  做为表头分隔,以 | 做为列分隔,以下代码:
表头1|表头2
---|---
单元格1|单元格2
单元格3|单元格4
效果为:
| 表头1 | 表头2 | 
|---|---|
| 单元格1 | 单元格2 | 
| 单元格3 | 单元格4 | 
而且还可以通过在表头分隔符中添加 : 来决定单元格的对齐方向,以下代码:
表头1|表头2|表头3
:--|:--:|--:
左1|中1|右1
左2|中2|右2
效果为:
| 表头1 | 表头2 | 表头3 | 
|---|---|---|
| 左1 | 中1 | 右1 | 
| 左2 | 中2 | 右2 | 
如果需要在正文里使用特殊字符的话,可以用 \ 来转义
最后虽然 GFW 支持 Html 标签,不过本次项目中不允许在 MarkDown 中插入 Html 标签