一、前言
之前有了解過markdown,但一直沒實(shí)際使用,今天試用了下,感覺很爽,推薦給大家,特別是在編寫規(guī)范、接口文檔等方面非常適合,因?yàn)槠浜唵我子靡灿泻芏嗳擞脕韺懢W(wǎng)絡(luò)小說。
二、介紹
Markdown 的目標(biāo)是實(shí)現(xiàn)易讀易寫,可以直接在問編輯器書寫和保存,除本身具有非常好的可讀寫外,還可以生存格式非常好看的html代碼發(fā)布在互聯(lián)網(wǎng)中。
如鏈接:腳本之家,其書寫格式為:
[腳本之家](https://www.jb51.net/)
Markdown 不是想要取代 HTML,甚至也沒有要和它相近,它的語法種類很少,只對(duì)應(yīng) HTML 標(biāo)記的一小部分。Markdown 的構(gòu)想不是要使得 HTML 文檔更容易書寫。在我看來, HTML 已經(jīng)很容易寫了。Markdown 的理念是,能讓文檔更容易讀、寫和隨意改。HTML 是一種發(fā)布的格式,Markdown 是一種書寫的格式。就這樣,Markdown 的格式語法只涵蓋純文本可以涵蓋的范圍。
三、語法介紹
(一)區(qū)塊元素
段落和換行
一個(gè) Markdown 段落是由一個(gè)或多個(gè)連續(xù)的文本行組成,它的前后要有一個(gè)以上的空行(空行的定義是顯示上看起來像是空的,便會(huì)被視為空行。比方說,若某一行只包含空格和制表符,則該行也會(huì)被視為空行)。普通段落不該用空格或制表符來縮進(jìn)。
「由一個(gè)或多個(gè)連續(xù)的文本行組成」這句話其實(shí)暗示了 Markdown 允許段落內(nèi)的強(qiáng)迫換行(按入兩個(gè)以上的空格然后回車)
標(biāo)題
Markdown 支持兩種標(biāo)題的語法,類 Setext 和類 [atx][2] 形式,我們這里只介紹我建議使用的Atx 形式. 類 Atx 形式則是在行首插入 1 到 6 個(gè) # ,對(duì)應(yīng)到標(biāo)題 1 到 6 階,例如:
復(fù)制代碼 代碼如下:
# 這是H1
## 這是 H2
###### 這是H6
區(qū)塊引用 Blockquotes
Markdown 標(biāo)記區(qū)塊引用是使用類似 email 中用 > 的引用方式,如:
復(fù)制代碼 代碼如下:
>這是一個(gè)區(qū)塊引用
>這是一個(gè)區(qū)塊引用
展現(xiàn)形式為:
這是一個(gè)區(qū)塊引用
這是一個(gè)區(qū)塊引用
列表
Markdown 支持有序列表和無序列表。
無序列表使用星號(hào)、加號(hào)或是減號(hào)作為列表標(biāo)記:如:
復(fù)制代碼 代碼如下:
* Red
* Green
* Blue
有序列表則使用數(shù)字接著一個(gè)英文句點(diǎn):
復(fù)制代碼 代碼如下:
1. Bird
2. McHale
3. Parish
代碼區(qū)塊
這功能應(yīng)該是我們程序員最喜歡的功能,在 Markdown 中建立代碼區(qū)塊很簡單,只要簡單地縮進(jìn) 4 個(gè)空格或是 1 個(gè)制表符就可以,有些還支持代碼高亮。
復(fù)制代碼 代碼如下:
這是一個(gè)普通段落
這是一個(gè)代碼區(qū)塊。
分隔線
你可以在一行中用三個(gè)以上的星號(hào)、減號(hào)、底線來建立一個(gè)分隔線,行內(nèi)不能有其他東西。你也可以在星號(hào)或是減號(hào)中間插入空格。下面每種寫法都可以建立分隔線:
復(fù)制代碼 代碼如下:
* * *
***
*****
- - -
---------------------------------------
(二)區(qū)段元素
鏈接
Markdown 支持兩種形式的鏈接語法: 行內(nèi)式和參考式兩種形式
不管是哪一種,鏈接文字都是用 [方括號(hào)] 來標(biāo)記。
這里只介紹行內(nèi)式,參考式可以訪問本文后面的參考鏈接詳細(xì)了解。
要建立一個(gè)行內(nèi)式的鏈接,只要在方塊括號(hào)后面緊接著圓括號(hào)并插入網(wǎng)址鏈接即可,如果你還想要加上鏈接的 title 文字,只要在網(wǎng)址后面,用雙引號(hào)把 title 文字包起來即可,例如:
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
強(qiáng)調(diào)
Markdown 使用星號(hào)(*)和底線(_)作為標(biāo)記強(qiáng)調(diào)字詞的符號(hào),被 * 或 _ 包圍的字詞會(huì)被轉(zhuǎn)成用 em> 標(biāo)簽包圍,用兩個(gè) * 或 _ 包起來的話,則會(huì)被轉(zhuǎn)成 strong>,例如:
復(fù)制代碼 代碼如下:
*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
代碼
如果要標(biāo)記一小段行內(nèi)代碼,你可以用反引號(hào)把它包起來(`),例如:
則會(huì)被轉(zhuǎn)成 `strong>`
圖片
很明顯地,要在純文字應(yīng)用中設(shè)計(jì)一個(gè)「自然」的語法來插入圖片是有一定難度的。 Markdown 使用一種和鏈接很相似的語法來標(biāo)記圖片,同樣也允許兩種樣式: 行內(nèi)式和參考式。 這里也只介紹行內(nèi)式:
復(fù)制代碼 代碼如下:
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")
詳細(xì)敘述如下:
一個(gè)驚嘆號(hào) !
接著一個(gè)方括號(hào),里面放上圖片的替代文字
接著一個(gè)普通括號(hào),里面放上圖片的網(wǎng)址,最后還可以用引號(hào)包住并加上 選擇性的 ‘title' 文字。
(三)其它
自動(dòng)鏈接
Markdown 支持以比較簡短的自動(dòng)鏈接形式來處理網(wǎng)址和電子郵件信箱,只要是用方括號(hào)包起來, Markdown 就會(huì)自動(dòng)把它轉(zhuǎn)成鏈接。一般網(wǎng)址的鏈接文字就和鏈接地址一樣,例如:
復(fù)制代碼 代碼如下:
http://example.com/>
address@example.com>
Markdown 會(huì)轉(zhuǎn)為:
復(fù)制代碼 代碼如下:
a >http://example.com//a>
a href="mailto:address@example.com">address@example.com/a>
反斜杠
Markdown 可以利用反斜杠來插入一些在語法中有其它意義的符號(hào),例如:如果你想要用星號(hào)加在文字旁邊的方式來做出強(qiáng)調(diào)效果(但不用 em> 標(biāo)簽),你可以在星號(hào)的前面加上反斜杠: literal asterisks Markdown 支持以下這些符號(hào)前面加上反斜杠來幫助插入普通的符號(hào):
復(fù)制代碼 代碼如下:
\&; 反斜線
` 反引號(hào)
* 星號(hào)
_ 底線
{} 花括號(hào)
[] 方括號(hào)
() 括弧
# 井字號(hào)
+ 加號(hào)
- 減號(hào)
. 英文句點(diǎn)
! 驚嘆號(hào)
markdown編輯器
markdown的編輯器基本都支持實(shí)時(shí)預(yù)覽功能,下面介紹幾個(gè)我在用的。
1.我自己在用的woidows markdown編輯器是markdownpad 2,覺還不錯(cuò)
2.在線編輯器有mahua
3.wordpress編輯器:wp-markdown
參考鏈接
Markdown 語法說明 (簡體中文版):http://wowubuntu.com/markdown/
您可能感興趣的文章:- CommonMark 使用教程:將 Markdown 語法轉(zhuǎn)成 Html
- Markdown語法備忘
- VSCODE配置Markdown及Markdown基礎(chǔ)語法詳解