1. 標題
Markdown 支持兩種標題的語法,類 Setext 和類 atx 形式。
類 Setext 形式是用底線的形式,利用 = (最高階標題)和 - (第二階標題),例如:
This is an H1
=============
This is an H2
-------------
效果如下(任何數量的 = 和 - 都可以有效果。):
This is an H1
This is an H2
類 Atx 形式則是在行首插入 1 到 6 個 # ,對應到標題 1 到 6 階,例如:
# 這是 H1
## 這是 H2
###### 這是 H6
效果如下:
這是 H1
這是 H2
這是 H6
2. 區塊引用 Blockquotes
Markdown 標記區塊引用是使用類似 email 中用 > 的引用方式。如果你還熟悉在 email 信件中的引言部分,你就知道怎么在 Markdown 文件中建立一個區塊引用,那會看起來像是你自己先斷好行,然后在每行的最前面加上 > :
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
效果如下:
This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
Markdown 也允許你偷懶只在整個段落的第一行最前面加上 > :
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
效果如下:
This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
區塊引用可以嵌套(例如:引用內的引用),只要根據層次加上不同數量的 > :
> This is the first level of quoting.
>
>> This is nested blockquote.
>
> Back to the first level.
效果如下:
This is the first level of quoting.
This is nested blockquote.
Back to the first level.
引用的區塊內也可以使用其他的 Markdown 語法,包括標題、列表、代碼區塊等:
> ## 這是一個標題。
> 1. 這是第一行列表項。
> 2. 這是第二行列表項。
>
> 給出一些例子代碼:
>
> return shell_exec("echo $input | $markdown_script");
效果如下:
這是一個標題。
- 這是第一行列表項。
- 這是第二行列表項。
給出一些例子代碼:
return shell_exec("echo $input | $markdown_script");
3. 列表
Markdown 支持有序列表和無序列表。
無序列表使用星號、加號或是減號作為列表標記(三者等同):
* Red
* Green
* Blue
+ 111
+ 222
+ 333
- Red
- Green
- Blue
效果如下:
- Red
- Green
- Blue
- 111
- 222
- 333
- Red
- Green
- Blue
有序列表則使用數字接著一個英文句點:
1. Bird
2. McHale
3. Parish
效果如下
- Bird
- McHale
- Parish
如果要在列表項目內放進引用,那 `>`` 就需要縮進:
* A list item with a blockquote:
> This is a blockquote
> inside a list item.
效果如下:
-
A list item with a blockquote:
This is a blockquote
inside a list item.
4. 代碼區塊
Markdown 會用< pre > 和 < code > 標簽來把代碼區塊包起來。
要在 Markdown 中建立代碼區塊很簡單,只要簡單地縮進 4 個空格或是 1 個制表符就可以,例如,下面的輸入:
這是一個普通段落:
這是一個代碼區塊。
效果如下:
這是一個代碼區塊。
一個代碼區塊會一直持續到沒有縮進的那一行(或是文件結尾)。
5. 分隔線
你可以在一行中用三個以上的星號、減號、底線來建立一個分隔線,行內不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立分隔線:
* * *
***
*****
- - -
---------------------------------------
效果如下:
6. 區段元素 - 鏈接
Markdown 支持兩種形式的鏈接語法: 行內式和參考式兩種形式。
不管是哪一種,鏈接文字都是用 [方括號] 來標記。
要建立一個行內式的鏈接,只要在方塊括號后面緊接著圓括號并插入網址鏈接即可,如果你還想要加上鏈接的 title 文字,只要在網址后面,用雙引號把 title 文字包起來即可,例如:
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
效果如下:
This is an example inline link.
This link has no title attribute.
如果你是要鏈接到同樣主機的資源,你可以使用相對路徑:
See my [About](/about/) page for details.
效果如下:
See my About page for details.
參考式的鏈接是在鏈接文字的括號后面再接上另一個方括號,而在第二個方括號里面要填入用以辨識鏈接的標記:
This is [an example][id] reference-style link.
你也可以選擇性地在兩個方括號中間加上一個空格:
This is [an example] [id] reference-style link.
接著,在文件的任意處,你可以把這個標記的鏈接內容定義出來:
[id]: http://example.com/ "Optional Title Here"
下面是一個參考式鏈接的范例:
I get 10 times more traffic from [Google] [1] than from
[Yahoo] [2] or [MSN] [3].
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"
I get 10 times more traffic from Google than from
Yahoo or MSN.
如果改成用鏈接名稱的方式寫:
I get 10 times more traffic from [Google][] than from
[Yahoo][] or [MSN][].
[google]: http://google.com/ "Google"
[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[msn]: http://search.msn.com/ "MSN Search"
I get 10 times more traffic from Google than from
Yahoo or MSN.
7. 強調
Markdown 使用星號(*)和底線(_)作為標記強調字詞的符號,被 或 _ 包圍的字詞會被轉成用< i > 標簽包圍,用兩個 或 _ 包起來的話,則會被轉成 < strong > ,例如:
*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
效果如下:
single asterisks
single underscores
double asterisks
double underscores
8. 代碼
如果要標記一小段行內代碼,你可以用反引號把它包起來(),例如: ```Use the
printf()` function.```
效果如下:
Use the printf()
function.
如果要在代碼區段內插入反引號,你可以用多個反引號來開啟和結束代碼區段:
There is a literal backtick (`) here.
效果如下:
There is a literal backtick (`) here.
代碼區段的起始和結束端都可以放入一個空白,起始端后面一個,結束端前面一個,這樣你就可以在區段的一開始就插入反引號:
A single backtick in a code span: `` ` ``
A backtick-delimited string in a code span: `` `foo` ``
效果如下:
A single backtick in a code span: `
A backtick-delimited string in a code span: `foo`
在代碼區段內,& 和尖括號都會被自動地轉成 HTML 實體,這使得插入 HTML 原始碼變得很容易
9. 圖片
很明顯地,要在純文字應用中設計一個「自然」的語法來插入圖片是有一定難度的。
Markdown 使用一種和鏈接很相似的語法來標記圖片,同樣也允許兩種樣式: 行內式和參考式。
行內式的圖片語法是:


詳細敘述如下:
一個驚嘆號 ! + 一個方括號,里面放上圖片的替代文字 + 一個普通括號,里面放上圖片的網址,最后還可以用引號包住并加上 選擇性的 'title' 文字。
參考式的圖片語法:
![Alt text][id]
「id」是圖片參考的名稱,圖片參考的定義方式則和連結參考一樣:
[id]: url/to/image "Optional title attribute"
到目前為止, Markdown 還沒有辦法指定圖片的寬高,如果你需要的話,你可以使用普通的<img>標簽。
本地圖片上傳
登陸http://yotuku.cn/
上傳圖片,點擊markdown,粘貼到markdown文檔即可
10. 刪除線
GFM增加了刪除線
~~Mistaken text.~~
效果如下:
Mistaken text.
11. 代碼塊
如果有一整塊代碼需要包圍, 可以使用```
例如:
x = 0
x = 2 + 2
what is x
效果如下:
x = 0
x = 2 + 2
what is x
12. 語法高亮
代碼塊可以使用語法高亮了!!在你的代碼塊中添加一個可選的語言標識符,我們會通過語法高亮顯示運行它。例如,為了語法高亮ruby代碼:
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
效果如下:
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
13. 表格
你可以創建表格,通過符號-分開第一行和其他行,通過|分開各個列
姓名 | 年齡 | 班級
-----|-----|-----
張三 | 28607 | 396班
王五 | 30 | 4班
效果如下:
姓名 | 年齡 | 班級 |
---|---|---|
張三 | 28607 | 396班 |
王五 | 30 | 4班 |
在標題行包含:,你可以使得表格向左對齊,向右對齊,居中
:在最左邊表示左對齊,:在最右邊表示右對齊,左右兩邊都有:表示居中。
|姓名 | 年齡 | 班級|
|:-----:|:-----:|:-----:|
|張三 | 28607777 | 3967777班|
|王五 | 30 | 4班 |
效果如下:
姓名 | 年齡 | 班級 |
---|---|---|
張三 | 28607777 | 3967777班 |
王五 | 30 | 4班 |
使用atom編輯markdown文本
atom編輯器支持markdown文本的預覽(需要安裝markdown preview插件,默認已安裝),編輯文本的時候,快捷鍵ctrl-shift-M 即可打開markdown preview功能;
markdown preview插件信息可通過File->Settings->Filter packages輸入框輸入markdown preview->keybindings