简介

Markdown是一种标记语言,帮助你快速排版文章,语法由简单易懂的符号所组成,可以随时转换成HTML。简洁美观,以纯文本的方式保存,兼容性极强,易读易写,因而越来越流行。
这里有Markdown官方文档(英)(简)比较复杂,本文注重介绍Markdown的常见语法,一行语法一行示例,可以帮你快速入门,下面步入正题:

标题

Markdown标题语法 ,支持最多 级标题。

1
2
3
4
注意中间空格
# 一级标题
### 三级标题
###### 六级标题

一级标题

三级标题

六级标题

换行与空格

Markdown转换成HTML后会自动排版,所以无需手动换行。当然你也可以强制换行,先输入两个空格,然后按下Enter。(仅按一次Enter,会被视为空格)
按两次Enter,会留空一行并换行,在退出引言、清单时才用这样做,效果如下:

1
2
3
4
5
6
7
多个空格与空行都会识别成一个。
。。。。。。 。。。。。。。。9
。。。。。。 。。。。。。。。9
。。。。。。。。。。。。。。


9

。。。。。。 。。。。。。。。9
。。。。。。 。。。。。。。。9
。。。。。。。。。。。。。。

9

强调

强调使用星号 * 或者下划线 _ 都可以,一个代表斜体,两个代表加粗:

1
2
3
*一个斜体*    _一个斜体_ 
**两个加粗** __两个加粗__
***三个自然*** ___三个___

一个斜体 一个斜体
两个加粗 两个加粗
三个自然 三个

清单

Markdown支持无序清单和有序清单,退出清单模式,需留空一行
无序清单使用星号 * ,加 + 、减 - 作为标记,在标记前加两个Tab来表示代表多重清单,例:

1
2
3
4
5
6
7
8
空格不能少
* 清单一
* 清单二
* 清单三
- 清单一
- 清单二
- 清单三
+ 清单四
  • 清单一
  • 清单二
  • 清单三
  • 清单一
  • 一级清单
    • 二级清单
      • 三级清单
  • 清单四

有序清單則使用數字接著一個英文句點:

1
2
3
1.  Bird
2. McHale
3. Parish
  1. Bird
  2. McHale
  3. Parish

引言

开头使用 > 表示引言,多个 > 表示多重引言。(退出引言模式,需留空一行)
引言区域内还可以使用其他Markdown语法,包括标题、清单、程序源码:

1
2
3
4
>我们一来到世间,社会就会在我们面前树起了一个巨大的问号,你怎样度过自己的一生?我从来不把安逸和享乐看作是生活目的本身。 —— 爱因斯坦  

>人的智慧不用就会枯萎。 ——达芬·奇
>> #### 阿尔伯特·爱因斯坦生于德国

我们一来到世间,社会就会在我们面前树起了一个巨大的问号,你怎样度过自己的一生?我从来不把安逸和享乐看作是生活目的本身。 —— 爱因斯坦

人的智慧不用就会枯萎。 ——达芬·奇

阿尔伯特·爱因斯坦生于德国

分隔线

在一行中用三个或以上的星号 * 、下划线 _ 來建立一個分隔線,行內不能有除了空格以外的其他东西。

1
2
3
4
5
***
分隔线
___
分隔线
***

分隔线


分隔线


链接

有一行式与参考式,一行式比较简单[]后接(),可填写绝对地址或相对地址:

1
2
[This link](http://example.net/ "可选的描述") has no title attribute.
允许链接到标题 [简单链接](#简单链接)

This link has no title attribute.
简单链接
参考式便于阅读,链接体可放置文中任意位置,第二个[]可填可不填,填了链接体[]需与之对应:

1
2
3
4
I get 10 times more traffic from [Google][] than from[Yahoo][2] or [MSN][].
[google]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[msn]: http://search.msn.com/ "MSN Search"

I get 10 times more traffic from [Google][] than from[Yahoo][2] or [MSN][].
[google]: http://google.com/ “Google”
[2]: http://search.yahoo.com/ “Yahoo Search”
[msn]: http://search.msn.com/ “MSN Search”

简单链接

还有一种更简洁的方式,处理网址与邮件地址,只需用<>包括起来:

1
2
3
<http://example.com/>
<address@example.com>
对于邮件地址还会进行编码转换,以混淆部分机器。

http://example.com/
address@example.com

程序代码

在一行中引用一小块代码用``包括,一整行代码先空一行后缩进一个Tab:

1
2
3
4
markdown 以说明代码语言。
Use the `printf()` function.

Use the printf() function.

Use the printf() function.

use the printf() function.

代码段:
代码段

图片

和链接十分相似,同样也支持参考式:

1
2
![android](/images/Markdown1.png "example android")  ![apple][id]
[id]: /images/Markdown2.png "example apple"

android ![apple][id]
[id]: /images/Markdown2.png “example apple”

其他

  • Markdown 允许直接插入HTML代码,实现相应效果。
    直接插入(缩进)或是用``包括,最后HTML代码都会被执行。
  • 对于转义字符 \ * + - _ [] () # . ! 无法正确表示时,符号前加入\即可。
  • HTML标签符& <无法正确表示时,分别用&amp; &lt; 代替。

GitHub 特有语法(原文)

  • 简单表格
    1
    2
    3
    4
    5
    | Tables        | Are           | Cool  |
    | ------------- |:-------------:| -----:|
    | col 3 is | right-aligned | $1600 |
    | col 2 is | centered | $12 |
    | zebra stripes | are neat | $1 |
    Tables Are Cool
    col 3 is right-aligned $1600
    col 2 is centered $12
    zebra stripes are neat $1
  • 任务清单
    1
    2
    - [x] This is a complete item
    - [ ] This is an incomplete item
  • This is a complete item
  • This is an incomplete item
  • 目录
    不少Markdown解析器,生成目录只需另起一行输入[TOC]GitHub还不支持。
    暂时只能通过清单和链接标题的方式,手动制作目录。

    1
    2
    3
    * [简介](#简介)
    * [链接](#链接)
    * [图片](#图片)
  • 划去
    ~~包括,如~~划去~~划去

  • Emoji 表情
    在需要的地方输入相应代码, :sparkles: :sparkles: 表情列表

  • 呼叫与链接

    • GitHub允许呼叫相应用户、团队,使用@username
    • 可以通过commit SHA-1,自动生成指向commit的链接。
    • 可以通过Issues问题列表的序号#1,自动指向问题的链接。

参考:
Markdown繁体 http://markdown.tw/
Mastering Markdown https://guides.github.com/features/mastering-markdown/
markdown简明语法 http://ibruce.info/2013/11/26/markdown/
Markdown——入门指南 http://www.jianshu.com/p/1e402922ee32/