MarkDown常用語法介紹
學(xué)習(xí)過的內(nèi)容總要不斷的強(qiáng)化,之前只是看過一些markdown的寫法,并未真正寫過md文檔。最近,需要寫一些GitHub文檔,就深入學(xué)習(xí)MarkDown的寫法,并匯總了這一份文檔,且用MarkDown編輯。本文將會(huì)介紹一些MarkDown的基本標(biāo)記語法以及一些常用圖形的繪制,包括流程圖、甘特圖。
MarkDown是一種輕量級標(biāo)記語言,以一種純文本的形式編輯,最終可轉(zhuǎn)化為HTML格式發(fā)布,能夠讓編寫者沉浸其中,享受文檔編寫的快樂。
本文目錄
一、基本用法
一、基本用法
標(biāo)題
加在文本前面,將#后的文本作為標(biāo)題??蓪?shí)現(xiàn)h1-h6六級標(biāo)題,按照#的個(gè)數(shù)區(qū)分標(biāo)題等級。
例如:
# 一級標(biāo)題
## 二級標(biāo)題
### 三級標(biāo)題
#### 四級標(biāo)題
##### 五級標(biāo)題
###### 六級標(biāo)題
顯示效果:
一級標(biāo)題
二級標(biāo)題
三級標(biāo)題
四級標(biāo)題
五級標(biāo)題
六級標(biāo)題
區(qū)塊引用
當(dāng)你想要單獨(dú)引用某一段落,就要用到MarkDown中的區(qū)塊應(yīng)用>符號,并且可以疊加多個(gè)>嵌套使用。
例如:
> 曾經(jīng)有一份真摯的愛情擺在我面前,我沒有珍惜,等到失去了才后悔莫及。(區(qū)塊引用)
>> 如果再給我一次機(jī)會(huì),我想對那個(gè)女孩子說三個(gè)字。。。 (嵌套引用)
顯示效果:
> 曾經(jīng)有一份真摯的愛情擺在我面前,我沒有珍惜,等到失去了才后悔莫及。
>> 如果再給我一次機(jī)會(huì),我想對那個(gè)女孩子說三個(gè)字。。。
注意: ? > 和 文本之前記得保留一個(gè)空格。
列表
這里的列表是指分條列舉,在編輯時(shí),只需要將-加在每行的前面即可,
例如:
- 例子1,我說。。。
- 例子2,我說。。。
- 例子3,我說。。。
- 例子4,我說。。。- 例子4的介紹。。。。
顯示效果:
例子1,我說。。。
例子2,我說。。。
例子3,我說。。。
-
例子4,我說。。。
- 例子4的介紹。。。。
如果想要將前面的原點(diǎn)換成數(shù)字,變成有序列表,那就在每行前面加 1.? 2.? 3.??即可。
例如:
1. 例子1,我說。。。
2. 例子2,我說。。。
3. 例子3,我說。。。
4. 例子4,我說。。。
??4.1 例子4的介紹。。。
顯示效果:
- 例子1,我說。。。
- 例子2,我說。。。
- 例子3,我說。。。
- 例子4,我說。。。
4.1 例子4的介紹。。。
粗體和斜體
粗體或者斜體的使用就更簡單了,只需要在需要強(qiáng)調(diào)的文本左右加上*或者_。
例如:
*我是誰*(
斜體)
_我在哪兒_ (斜體)
**我是誰**(粗體)
__我在哪兒__ (粗體)
顯示效果:
我是誰(
斜體)
我在哪兒 (斜體)
我是誰(粗體)
我在哪兒 (粗體)
代碼引用
代碼引用的時(shí)候,需要在每個(gè)代碼行前面加一個(gè)Tab或者4個(gè)空格,也可以使用 , 單行使用 包裹,多行使用```包裹代碼,效果與tab相同。
例如:
普通段落
function add (x, y) {
return x + y;
}
代碼塊:
function add (x, y) {
return x + y;
}
function () {
}
鏈接與圖片
鏈接和圖片的添加方法類似,方法有兩種行內(nèi)式和參數(shù)式。(也可使用html的方法,通過<a></a>添加)
鏈接:
[我是Github,請點(diǎn)我](https://github.com/HamsinD/MarkDown_summary) (
行內(nèi)式)
效果:我是Github,請點(diǎn)我
[我是Github,請點(diǎn)我](Github) (
參數(shù)式)
[Github](https://github.com/HamsinD/MarkDown_summary)
效果:
我是Github,請點(diǎn)我
添加圖片只需要在鏈接的格式前面加!。
圖片:
表格
表格的寫法比較有意思,通過|和-來繪制表格,具體看寫法:
| tab1 | tab2 | tab3 |
| ---------- |:--------:| -------:|
| xxxxxxx | xxxxxxx | xxxxxxx |
| xxxxxxx | xxxxxxx | xxxxxxx |
顯示效果:
| tab1 | tab2 | tab3 |
|---|---|---|
| xxxxxxx | xxxxxxx | xxxxxxx |
| xxxxxxx | xxxxxxx | xxxxxxx |
注意: 表頭線-兩側(cè)的:用來設(shè)置居中方式。
注意點(diǎn):
- 段落的前后要有空行,所謂的空行是指沒有文字內(nèi)容。若想在段內(nèi)強(qiáng)制換行的方式是使用兩個(gè)以上空格加上回車(引用中換行省略回車)。
- 一個(gè)空格輸入
即可