以前總覺得office是大家通用的,以后在公司寫需求文檔什么的肯定也要用,所以收藏了好多的教程。后來男朋友去實習(xí)后跟我說公司里寫需求文檔都要求用MarkDown,他覺得我學(xué)一下很有必要,況且MarkDown使用也很廣泛,我在看github上的項目的時候也經(jīng)??吹酱罄杏?md的說明文檔。
所以??!作為一名程序員,我要根據(jù)目前我常用的順序記錄下它的使用規(guī)則。
1. 當(dāng)然是代碼
- 代碼塊:
敲四個空格然后不用換行直接敲代碼就可以出現(xiàn)代碼塊區(qū),結(jié)尾也是不用換行直接再敲四個空格即可關(guān)閉代碼區(qū)。
或用```+一個空格+代碼所用語言(eg:html)(不必須寫)+回車即可在代碼區(qū)寫代碼,結(jié)尾在代碼的末尾換行再用三個 ` 封鎖代碼區(qū)
例如:
<div class="test">
hello
</div>
- 行內(nèi)代碼:
用`在代碼兩端進行包裹即可產(chǎn)生。
例如<div></div>
2.標(biāo)題
- 通過在標(biāo)題文字前加#來設(shè)置標(biāo)題級別。
一到六級標(biāo)題分別對應(yīng)一到六個#,一級標(biāo)題最大。 - 或在標(biāo)題文字的下一行用任意個=來標(biāo)識一級標(biāo)題,任意個-標(biāo)識二級標(biāo)題。
3.列表
用-或*或+加一個空格即可表示無序列表
例如:
- 示例
有序列表直接用數(shù)字加英文句點即可。
4.引用
引用以>來表示。引用中支持多級引用、標(biāo)題、列表、代碼塊、分割線等常規(guī)語法。
例如:
示例引用
二級引用
5.強調(diào)
在文本兩端加上兩個標(biāo)識加粗文本
文本兩端加上一個標(biāo)識斜體文本
文本兩端加上兩個~ 標(biāo)識刪除文本,eg:示例
6.圖片和鏈接
!+[圖片說明文字,可不寫]+(圖片url)
[鏈接說明文字,可不寫]+(鏈接url)
這是行內(nèi)式鏈接:[百度](http://www.baidu.com).
這是參考式鏈接:[百度][url],其中url為鏈接標(biāo)記,可置于文中任意位置。
[url]: http://www.baidu.com
鏈接標(biāo)記格式為:[鏈接標(biāo)記文本]: 鏈接地址 鏈接title(可忽略)
這是自動鏈接:直接使用`<>`括起來<http://www.baidu.com>
顯示為:
這是行內(nèi)式鏈接:百度.
這是參考式鏈接:[百度][url],其中url為鏈接標(biāo)記,可置于文中任意位置。
[url]: http://www.baidu.com
鏈接標(biāo)記格式為:[鏈接標(biāo)記文本]: 鏈接地址 鏈接title(可忽略)
這是自動鏈接:直接使用<>括起來http://www.baidu.com
7.分隔線
在一行中用三個以上的*、-、_來建立一個分隔線,行內(nèi)不能有其他東西。也可以在符號間插入空格。例如:
8.表格
表格對齊格式
- 居左::----
- 居中::----:或-----
- 居右:----:
例如:
|th1|th2|th3|
|:---|:---:|---:|
|居左|居中|居右|
|apple|tomato|orange|
|red|yellow|blue|
| th1 | th2 | th3 |
|---|---|---|
| 居左 | 居中 | 居右 |
| apple | tomato | orange |
| red | yellow | blue |