Markdown 教程
Markdown 是一種輕量級(jí)標(biāo)記語言真慢,它允許人們使用易讀易寫的純文本格式編寫文檔毅臊。
Markdown 語言在 2004 由約翰·格魯伯(英語:John Gruber)創(chuàng)建。
Markdown 編寫的文檔可以導(dǎo)出 HTML 黑界、Word管嬉、圖像、PDF朗鸠、Epub 等多種格式的文檔蚯撩。
Markdown 編寫的文檔后綴為 .md, .markdown。
Markdown 應(yīng)用
Markdown 能被使用來撰寫電子書烛占,如:Gitbook胎挎。
當(dāng)前許多網(wǎng)站都廣泛使用 Markdown 來撰寫幫助文檔或是用于論壇上發(fā)表消息。例如:GitHub忆家、簡(jiǎn)書犹菇、reddit、Diaspora芽卿、Stack Exchange揭芍、OpenStreetMap 、SourceForge等卸例。
編輯器
本教程將使用 Typora 編輯器來講解 Markdown 的語法称杨,Typora 支持 MacOS 、Windows币厕、Linux 平臺(tái)列另,且包含多種主題,編輯后直接渲染出效果旦装。
支持導(dǎo)出HTML、PDF摊滔、Word阴绢、圖片等多種類型文件。
Typora 官網(wǎng):https://typora.io/
你也可以使用簡(jiǎn)書的編輯器去驗(yàn)證艰躺。
有用的書籍
《了不起的Markdown》:
Markdown 標(biāo)題
Markdown 標(biāo)題有兩種格式呻袭。
使用 # 號(hào)標(biāo)記
使用 # 號(hào)可表示 1-6 級(jí)標(biāo)題,一級(jí)標(biāo)題對(duì)應(yīng)一個(gè) # 號(hào)腺兴,二級(jí)標(biāo)題對(duì)應(yīng)兩個(gè) # 號(hào)左电,以此類推。
# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
#### 四級(jí)標(biāo)題
##### 五級(jí)標(biāo)題
###### 六級(jí)標(biāo)題
展示效果
一級(jí)標(biāo)題
二級(jí)標(biāo)題
三級(jí)標(biāo)題
四級(jí)標(biāo)題
五級(jí)標(biāo)題
六級(jí)標(biāo)題
Markdown 段落
Markdown 段落沒有特殊的格式,直接編寫文字就好篓足,段落的換行是使用兩個(gè)以上空格加上回車段誊。
你好
我已經(jīng)換行了。
當(dāng)然也可以在段落后面使用一個(gè)空行來表示重新開始一個(gè)段落栈拖。
字體
Markdown 可以使用以下幾種字體:
*斜體文本*
_斜體文本_
**粗體文本**
__粗體文本__
***粗斜體文本***
___粗斜體文本___
顯示效果如下所示:
斜體文本
斜體文本
粗體文本
粗體文本
粗斜體文本
粗斜體文本
分隔線
你可以在一行中用三個(gè)以上的星號(hào)连舍、減號(hào)、底線來建立一個(gè)分隔線涩哟,行內(nèi)不能有其他東西索赏。你也可以在星號(hào)或是減號(hào)中間插入空格。下面每種寫法都可以建立分隔線:
***
* * *
*****
- - -
----------
顯示效果如下所示:
刪除線
如果段落上的文字要添加刪除線贴彼,只需要在文字的兩端加上兩個(gè)波浪線 ~~ 即可潜腻,實(shí)例如下:
~這是刪除線~
顯示效果如下所示:
這是刪除線
Markdown 列表
Markdown 支持有序列表和無序列表。
無序列表使用星號(hào)(*)器仗、加號(hào)(+)或是減號(hào)(-)作為列表標(biāo)記砾赔,這些標(biāo)記后面要添加一個(gè)空格,然后再填寫內(nèi)容:
* 第一項(xiàng)
* 第二項(xiàng)
* 第三項(xiàng)
+ 第一項(xiàng)
+ 第二項(xiàng)
+ 第三項(xiàng)
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
顯示結(jié)果如下:
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
有序列表使用數(shù)字并加上 . 號(hào)來表示青灼,如:
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
顯示結(jié)果如下:
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
列表嵌套
列表嵌套只需在子列表中的選項(xiàng)前面添加四個(gè)空格即可:
- 第一項(xiàng):
- 第一項(xiàng)嵌套的第一個(gè)元素
- 第一項(xiàng)嵌套的第二個(gè)元素- 第二項(xiàng):
- 第二項(xiàng)嵌套的第一個(gè)元素
- 第二項(xiàng)嵌套的第二個(gè)元素
顯示結(jié)果如下:
- 第一項(xiàng):
- 第一項(xiàng)嵌套的第一個(gè)元素
- 第一項(xiàng)嵌套的第二個(gè)元素
- 第二項(xiàng):
- 第二項(xiàng)嵌套的第一個(gè)元素
- 第二項(xiàng)嵌套的第二個(gè)元素
Markdown 區(qū)塊
Markdown 區(qū)塊引用是在段落開頭使用 > 符號(hào) 暴心,然后后面緊跟一個(gè)空格符號(hào):
> 區(qū)塊引用
> Markdown教程
顯示結(jié)果如下:
區(qū)塊引用
Markdown教程
另外區(qū)塊是可以嵌套的,一個(gè) > 符號(hào)是最外層杂拨,兩個(gè) > 符號(hào)是第一層嵌套专普,以此類推:
> 最外層
> > 第一層嵌套
> > > 第二層嵌套
顯示結(jié)果如下:
最外層
第一層嵌套
第二層嵌套
區(qū)塊中使用列表
區(qū)塊中使用列表實(shí)例如下:
> 區(qū)塊中使用列表
> 1. 第一項(xiàng)
> 2. 第二項(xiàng)
> + 第一項(xiàng)
> + 第二項(xiàng)
> + 第三項(xiàng)
顯示結(jié)果如下:
區(qū)塊中使用列表
- 第一項(xiàng)
- 第二項(xiàng)
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
列表中使用區(qū)塊
如果要在列表項(xiàng)目?jī)?nèi)放進(jìn)區(qū)塊,那么就需要在 > 前添加四個(gè)空格的縮進(jìn)弹沽。
區(qū)塊中使用列表實(shí)例如下:
* 第一項(xiàng)
????> 區(qū)塊引用
????> Markdown教程
* 第二項(xiàng)
顯示結(jié)果如下:
- 第一項(xiàng)
區(qū)塊引用
Markdown教程- 第二項(xiàng)
Markdown 代碼
如果是段落上的一個(gè)函數(shù)或片段的代碼可以用反引號(hào)把它包起來(`)檀夹,例如:
`printf()` 函數(shù)
顯示結(jié)果如下:
printf()
函數(shù)
代碼區(qū)塊
代碼區(qū)塊使用 4 個(gè)空格或者一個(gè)制表符(Tab 鍵)。
實(shí)例如下:
??printf("hello world!")
顯示結(jié)果如下:
printf("hello world!")
你也可以用 ``` 包裹一段代碼策橘,并指定一種語言(也可以不指定):
```javascript
$(document).ready(function () {
alert('hello');
});
```
顯示結(jié)果如下:
$(document).ready(function () {
alert('hello');
});
Markdown 鏈接
鏈接使用方法如下:
[鏈接名稱](鏈接地址) 或者 <鏈接地址>
例如:
這是一個(gè)鏈接 [Markdown教程](http://www.reibang.com/u/b44b7da9f43d)
顯示結(jié)果如下:
這是一個(gè)鏈接 Markdown教程
直接使用鏈接地址:
http://www.reibang.com/u/b44b7da9f43d
Markdown 表格
Markdown 制作表格使用 | 來分隔不同的單元格炸渡,使用 - 來分隔表頭和其他行。
語法格式如下:
| 表頭 | 表頭 |
| ---- | ---- |
| 單元格 | 單元格 |
| 單元格 | 單元格 |
以上代碼顯示結(jié)果如下:
表頭 | 表頭 |
---|---|
單元格 | 單元格 |
單元格 | 單元格 |
對(duì)齊方式
我們可以設(shè)置表格的對(duì)齊方式:
- -: 設(shè)置內(nèi)容和標(biāo)題欄居右對(duì)齊丽已。
- :- 設(shè)置內(nèi)容和標(biāo)題欄居左對(duì)齊蚌堵。
- :-: 設(shè)置內(nèi)容和標(biāo)題欄居中對(duì)齊。
實(shí)例如下:
| 左對(duì)齊 | 右對(duì)齊 | 居中對(duì)齊 |
| :-----| ----: | :----: |
| 單元格 | 單元格 | 單元格 |
| 單元格 | 單元格 | 單元格 |
以上代碼顯示結(jié)果如下:
左對(duì)齊 | 右對(duì)齊 | 居中對(duì)齊 |
---|---|---|
單元格 | 單元格 | 單元格 |
單元格 | 單元格 | 單元格 |
Markdown 圖片
Markdown 圖片語法格式如下:

題")
- 開頭一個(gè)感嘆號(hào) !
- 接著一個(gè)方括號(hào)沛婴,里面放上圖片的替代文字
- 接著一個(gè)普通括號(hào)吼畏,里面放上圖片的網(wǎng)址,最后還可以用引號(hào)包住并加上選擇性的 'title' 屬性的文字嘁灯。
使用實(shí)例:
顯示結(jié)果如下:
以上是基礎(chǔ)教程的全部?jī)?nèi)容泻蚊,學(xué)習(xí)以上的內(nèi)容基本能夠正常使用markdown。
寫在最后
使用 Markdown 的誤區(qū)
We believe that writing is about content, about what you want to say – not about fancy formatting.
我們堅(jiān)信寫作寫的是內(nèi)容丑婿,所思所想性雄,而不是花樣格式没卸。
— Ulysses for Mac
Markdown 旨在簡(jiǎn)潔、高效秒旋,也由于 Markdown 的易讀易寫约计,人們用不同的編程語言實(shí)現(xiàn)了多個(gè)版本的解析器和生成器。這就導(dǎo)致了目前不同的 Markdown 工具集成了不同的功能(基礎(chǔ)功能大致相同)滩褥,例如流程圖與時(shí)序圖病蛉,復(fù)雜表格與復(fù)雜公式的呈現(xiàn)蒿涎。
雖然功能的豐富并沒有什么本質(zhì)的缺點(diǎn)悠反,但終歸有些背離初衷,何況在編寫的過程中很費(fèi)神且轨,不如使用專業(yè)的工具撰寫來的更有效率酒甸,所以如果你需實(shí)現(xiàn)復(fù)雜功能魄健,專業(yè)的圖形界面工具會(huì)更加方便。
當(dāng)然插勤,如果你對(duì)折騰這些不同客戶端對(duì) Markdown 的定制所帶來高階功能感到愉悅的話沽瘦,那也是無可厚非的。