Markdown是一種輕量級的標記語言。主要用於寫出帶有格式的文檔。有點相似於HTML語言,可是語法要比HTML語言簡單,十分適合書寫文檔。並且如今大部分博客和文章輸入系統都支持這種語法。例若有道筆記和印象筆記等等。在Github上寫的REAME.md就是這種語法寫出來的說明文檔。並且會在Github上直接顯示出帶有格式的文檔結果。html
Markdown 支持兩種標題的語法,類 Setext 和類 atx 形式。程序員
類 Setext 形式是用底線的形式,利用 = (最高階標題)和 - (第二階標題),例如:ubuntu
This is an H1 ============= This is an H2 -------------
文章的標題格式是最左側加上#
符號,以後有一個空格,最後右側寫上標題內容。一個井號表明一級標題,兩個井號表明二級標題,以此類推,一共有6級。markdown
# 這是 H1 ## 這是 H2 ###### 這是 H6
無序列表使用星號、加號或是減號做爲列表標記. 例如:curl
* Red * Green * Blue
或者工具
+ Red + Green + Blue
等同於:學習
- Red - Green - Blue
有序列表是指在列表的每一行前面帶有1, 2, 3...數字。這種列表須要在每一行文字前面增長數字+點的方式。例如"1."。而後再接文字。網站
Markdown 標記區塊引用是使用相似 email 中用 >
的引用方式。使用大於號在文字前面。google
區塊引用能夠嵌套(例如:引用內的引用),只要根據層次加上不一樣數量的 >
。url
圖片是在一個對圖片的鏈接,而不是能嵌入圖片。有點像html的img標籤的src屬性。具體的寫法爲:![Alt text](image_url)
Markdown 支持兩種形式的連接語法: 行內式和參考式兩種形式。無論是哪種,連接文字都是用 [方括號] 來標記。
格式爲: [an example](http://example.com/ "Title")
.
通常簡寫成[an example](http://example.com/)
參考式的連接是在連接文字的括號後面再接上另外一個方括號,而在第二個方括號裏面要填入用以辨識連接的標記: This is [an example][id] reference-style link.
而後在下面的參考位置定義ID的值: [id]: http://example.com/ "Optional Title Here"
連接網址也能夠用尖括號包起來。
[id]: <http://example.com/> "Optional Title Here"
隱式連接標記功能讓你能夠省略指定連接標記,這種情形下,連接標記會視爲等同於連接文字,要用隱式連接標記只要在連接文字後面加上一個空的方括號,若是你要讓 "Google" 連接到 google.com,你能夠簡化成:
[Google][]
而後定義連接內容:
[Google]: http://google.com/
連接的定義能夠放在文件中的任何一個地方,我比較偏好直接放在連接出現段落的後面,你也能夠把它放在文件最後面,就像是註解同樣。
使用兩個**
和兩個下劃線圍繞文字的左右側。
使用*
和一個下劃線圍繞文字的左右側。
注意: 若是你的 *
和 _
兩邊都有空白的話,它們就只會被當成普通的符號。
格式以下
| 列表頭1 | 列表頭2 | 列表頭3 | | ------------- |:-------------:| --------:| | 內容1 | 內容2 | 內容3 | | 內容1 | 內容2 | 內容3 |
上面的:
表明對齊的方式。若是冒號兩邊都有那麼表明居中對齊。
代碼框是程序員寫的文檔常常用到的。格式有多種,一種是使用單個反引號(通常在鍵盤的左側tab鍵的上面),把代碼包圍起來。還有一種使用三個反引號把代碼包圍起來。若是代碼是多行的,建議使用三個反引號比較好,其還能夠指定代碼的類型,例如是Python代碼,或者HTML代碼,這樣顯示的效果能夠帶有語法高亮。
你能夠在一行中用三個以上的星號、減號、底線來創建一個分隔線,行內不能有其餘東西。你也能夠在星號或是減號中間插入空格。
Markdown語法使用的字符如何與你寫的文檔中的字符有衝突,那麼可使用\
來轉義Markdown的字符,變成普通的文字符號。
Markdown提供對以下字符的轉義:
\ backslash ` backtick * asterisk _ underscore {} curly braces [] square brackets () parentheses # hash mark + plus sign - minus sign (hyphen) . dot ! exclamation mark
Markdown兼容HTML中一些特殊字符寫法。例如版權符號使用@copy
;
參考: