1.語言介紹
Markdown 是一種可以使用普通文本編輯器編寫的標(biāo)記語言,通過簡單的標(biāo)記語法德迹,它可以使普通文本內(nèi)容具有一定的格式。
2.兼容 HTML
Markdown 語法的目標(biāo)是:成為一種適用于網(wǎng)絡(luò)的書寫語言揭芍。
3.特殊符號轉(zhuǎn)化
在 HTML 文件中胳搞,有兩個字符需要特殊處理: <
和 &
。
? 的寫法如下:
代碼如下:
©
AT&T markdown會將其轉(zhuǎn)換成
代碼如下:
AT&T
4.區(qū)塊元素
段落和換行
一個 Markdown 段落是由一個或多個連續(xù)的文本行組成咱扣,它的前后要有一個以上的空行营搅。普通段落不該用空格或制表符來縮進(jìn)篱蝇。
強(qiáng)制插入換行 <br/>
先按入兩個以上的空格然后回車。
4.1 標(biāo)題
這是 H1
這是 H2
===========
這是 H6
# 這是 H1
-------------
## 這是 H2
===========
###### 這是 H6
語法:
- 任何數(shù)量的
=
和-
都可以有效果悬而。 - 插入 1 到 6 個
#
,對應(yīng)到標(biāo)題 1 到 6 階锭汛,可選尾加上 笨奠,而行尾的#
數(shù)量也不用和開頭一樣。
4.2 區(qū)域引用
這是一個標(biāo)題唤殴。
- 這是第一行列表項般婆。
- 這是第二行列表項。
- 這個是列表展示
給出一些例子代碼:
這是第二行列表項眨八。
return shell_exec("echo $input | $markdown_script");
代碼如下:
> ## 這是一個標(biāo)題腺兴。
>
> 1. 這是第一行列表項。
> 2. 這是第二行列表項廉侧。
> * 這個是列表展示
>
> 給出一些例子代碼:
> > 這是第二行列表項页响。
>
> return shell_exec("echo $input | $markdown_script");
語法:
- 引用的區(qū)塊內(nèi)也可以使用其他的 Markdown 語法,包括標(biāo)題段誊、列表闰蚕、代碼區(qū)塊,如果嵌套引用模塊连舍,則需要前后哥家一個回車換行.
- Markdown 也允許你偷懶只在整個段落的第一行最前面加上
>
没陡。
4.3 列表
Markdown 支持有序列表和無序列表。
- Red
- Green
- Blue
- Red
- Green
- Blue
- Red
- Green
- Blue
Bird
-
McHale
引用內(nèi)容索赏,列表中的引用盼玄,換行+加縮緊
引用內(nèi)容,列表中的引用潜腻,換行+加縮緊
* Red
* Green
* Blue
+ Red
+ Green
+ Blue
- Red
- Green
- Blue
1. Bird
2. McHale
> 引用內(nèi)容埃儿,列表中的引用,換行+加縮緊
> 引用內(nèi)容融涣,列表中的引用童番,換行+加縮緊
語法: 列表項目內(nèi)放進(jìn)引用精钮,那 >
就需要縮進(jìn)。
-
這是一個段落剃斧,此部分是可以進(jìn)行縮進(jìn)的轨香,輸入對應(yīng)的空格或是制表符即可縮進(jìn)
這是一個縮進(jìn)段落
這是一個段落,此部分是可以進(jìn)行縮進(jìn)的幼东,輸入對應(yīng)的空格或是制表符即可縮進(jìn)
代碼如下:
1. 這是一個段落臂容,此部分是可以進(jìn)行縮進(jìn)的,輸入對應(yīng)的空格或是制表符即可縮進(jìn)
這是一個縮進(jìn)段落
2. 這是一個段落筋粗,此部分是可以進(jìn)行縮進(jìn)的策橘,輸入對應(yīng)的空格或是制表符即可縮進(jìn)
語法: 列表項目可以包含多個段落,每個項目下的段落都必須縮進(jìn) 4 個空格或是 1 個制表符娜亿。
是在行首出現(xiàn)數(shù)字-句點-空白丽已,要避免這樣的狀況,你可以在句點前面加上反斜杠买决,避免序列號沛婴。
1986. What a great season.
代碼如下:
1986\. What a great season.
4.4 代碼區(qū)塊
這是一個代碼區(qū)塊:
tell application "Foo"
beep
end tell
<div class="footer">
© 2004 Foo Corporation
</div>
語法: Markdown 中建立代碼區(qū)塊,只要簡單地縮進(jìn) 4 個空格或是 1 個制表符就可以督赤,一個代碼區(qū)塊會一直持續(xù)到?jīng)]有縮進(jìn)的那一行(或是文件結(jié)尾)嘁灯。
Here is an example of AppleScript:
tell application "Foo"
beep
end tell
<div class="footer">
© 2004 Foo Corporation
</div>
代碼模塊也可以用(```
)、(~~~
)或單(`
)躲舌,如果想輸出三個(```
)則用跟多的(`
)引用起來丑婿。
print('Hello world!')
print('Hello world!')
print('Hello world!')
4.5 分割線
* * *
***
*****
- - -
---------------------------------------
4.6 區(qū)段元素
4.6.1 鏈接
Markdown 支持兩種形式的鏈接語法: 行內(nèi)式和參考式兩種形式。不管是哪一種没卸,鏈接文字都是用 [方括號] 來標(biāo)記羹奉。
行內(nèi)式的鏈接 在方塊括號后面緊接著圓括號并插入網(wǎng)址鏈接即可,如果你還想要加上鏈接的 title 文字约计,只要在網(wǎng)址后面诀拭,用雙引號把 title 文字包起來即可,例如:
這是一個 an example 行內(nèi)鏈接.
This link 這個是五Title的聯(lián)機(jī).
可以使用相對路徑About.
代碼如下:
這是一個 [an example](http://example.com/ "Title") 行內(nèi)鏈接.
[This link](http://example.net/) 這個是五Title的聯(lián)機(jī).
可以使用相對路徑[About](/about/).
參考式的鏈接 是在鏈接文字的括號后面再接上另一個方括號煤蚌,而在第二個方括號里面要填入用以辨識鏈接的標(biāo)記耕挨。
這是一個參考試鏈接 an example,參考試鏈接必須有對應(yīng)的id值尉桩,否則無法連接.
代碼如下:
這是參考試鏈接 [an example][id] .
[id]: http://example.com/ "可選的title"
[id1]: <http://example.com/> "可選的title"
語法:
- 方括號(前面可以選擇性地加上至多三個空格來縮進(jìn))筒占,里面輸入鏈接文字
- 接著一個冒號
- 接著一個以上的空格或制表符
- 接著鏈接的網(wǎng)址
- 選擇性地接著 title 內(nèi)容,可以用單引號蜘犁、雙引號或是括弧包著
- 鏈接網(wǎng)址也可以用尖括號包起來
隱式鏈接標(biāo)記 功能讓你可以省略指定鏈接標(biāo)記翰苫,這種情形下,鏈接標(biāo)記會視為等同于鏈接文字沽瘦,要用隱式鏈接標(biāo)記只要在鏈接文字后面加上一個空的方括號革骨,如果你要讓 "Google" 鏈接到 google.com,你可以簡化成:
[Google][]
[Google]: http://google.com/
下面是一個參考式鏈接的范例:
在 [Google] [1] 的搜索超過 [Yahoo] [2] 或 [MSN] [3].
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[2]: http://search.yahoo.com/ "Yahoo Search"
如果改成用鏈接名稱的方式寫:
在 [Google][] 中搜索超過 [Yahoo][] 或 [MSN][].
[google]: http://google.com/ "Google"
[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[msn]: http://search.msn.com/ "MSN Search"
4.7 強(qiáng)調(diào)
- 單星號
- 單下滑線
- 雙星號
- 雙下劃線
1. *單星號*
2. _單下滑線_
3. **雙星號**
4. __雙下劃線__
語法: *
和 _
兩邊都有空白的話析恋,它們就只會被當(dāng)成普通的符號,文字前后直接插入普通的星號或底線良哲,你可以用反斜線,如下:
*this text is surrounded by literal asterisks*
代碼如下:
\*this text is surrounded by literal asterisks\*
4.7 代碼
Use the printf()
function.
There is a literal backtick (`) here.
語法: 在代碼區(qū)段內(nèi)插入反引號助隧,你可以用多個反引號來開啟和結(jié)束代碼區(qū)段筑凫。代碼區(qū)段內(nèi),&
和<>
都會被自動地轉(zhuǎn)成 HTML 實體
請不要在任何情況下使用 <blink>
標(biāo)簽.
4.8 圖片


![Alt text][id1]
`[id1]: url/to/image "Optional title attribute"`
- 一個驚嘆號 !
- 接著一個方括號并村,里面放上圖片的替代文字
- 接著一個普通括號巍实,里面放上圖片的網(wǎng)址,最后還可以用引號包住并加上 選擇性的 'title' 文字哩牍。
4.9 自動鏈接
<http://example.com/>
<address@example.com>
4.10 反斜杠轉(zhuǎn)譯字符
利用反斜杠來插入一些在語法中有其它意義的符號.
Markdown 支持以下這些符號前面加上反斜杠來幫助插入普通的符號:
\ 反斜線
` 反引號
* 星號
_ 底線
{} 花括號
[] 方括號
() 括弧
# 井字號
+ 加號
- 減號
. 英文句點
! 驚嘆號
5. 高級使用實例
5.1 鏈接方式棚潦,可以在其中加粗:
You can specify extra HTML rendering options through the Rendering preference pane.
You can specify extra HTML rendering options through the [**Rendering** preference pane](#rendering-pane).
5.2 列表縮進(jìn)(主要針對Macdown工具)
- 列表必須后邊緊跟一個空格
- 無序列表以
*
-
-
、+
也可以用- 嵌套進(jìn)行縮緊
- 支持順序編號
- 起始于數(shù)字后跟點并在點后加入空格 like
1.
- 可以不用順序, 自動順序編號
- 你可能想開始宇
1.
使其自動編號
- 嵌套進(jìn)行縮緊
代碼如下:
* 列表必須后邊緊跟一個空格
* 無序列表以 `*`
- `-`膝昆、`+` 也可以用
* 嵌套進(jìn)行縮緊
1. 支持順序編號
2. 起始于數(shù)字后跟點并在點后加入空格 like `1. `
42. 可以不用順序, 自動順序編號
1. 你可能想開始宇`1.` 使其自動編號
引用及引用中引用
尖括號
>
被用做引用丸边,一樣中換行,后變跟兩個以上空格.
語法上不是每個都需要一個>
段落之間沒有空行荚孵,否則會出現(xiàn)在換行引用.
引用中的引用妹窖,嵌套引用.嵌套引用這個是.
多嵌套醫(yī)用
多嵌套引用后續(xù)
- 列表
- 嵌套鏈接,鏈接引用號必須有收叶,否則會出現(xiàn)不能連接及顯示問題
- 等等.
代碼如下:
> 尖括號 `>` 被用做引用骄呼,一樣中換行,后變跟兩個以上空格.
語法上不是每個都需要一個 `>`
段落之間沒有空行判没,否則會出現(xiàn)在換行引用.
> 引用中的引用蜓萄,嵌套引用.
> > 嵌套引用這個是.
> > > 多嵌套醫(yī)用
>
> 多嵌套引用后續(xù)
>
> * 列表
> * [嵌套聯(lián)機(jī)](#fenced-code-block),鏈接引用號必須有哆致,否則會出現(xiàn)不能連接及顯示問題
> * 等等.
嵌套代碼
內(nèi)嵌代碼
使用來表示: `內(nèi)嵌代碼`
如果你想顯示單個代碼 `反引號`
內(nèi)容, 使用兩個反引號绕德,并且用空格隔開`
,如果想想顯示兩個摊阀,則用三個`
耻蛇,``代碼塊 `反引號` ``
,以此類推胞此。
表格
以下表格:
First Header | Second Header |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
You can align cell contents with syntax like this:
Left Aligned | Center Aligned | Right Aligned |
---|---|---|
col 3 is | some wordy text | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
為了美觀短豎線 (|
) 在開頭和結(jié)尾加上, 費必須. 空格無影響. 使用 :
表示對齊方式臣咖,中間對齊使用兩個,左對齊在左端漱牵,右對齊在右側(cè).
內(nèi)嵌代碼高亮顯示
只有在設(shè)置-rendering-Enable highlighting in code blocks開啟時才會有內(nèi)嵌代碼高亮顯示(macdown支持夺蛇,查看地址 ),可以在開頭寫上~~~python
import urllib3
import ssl
import json
from pip._vendor import requests
ssl._create_default_https_context = ssl._create_unverified_context
def getList():
表格內(nèi)的格式
Option name | Markup | Result if enabled |
---|---|---|
Intra-word emphasis | So A*maz*ing | So A<em>maz</em>ing |
Strikethrough | ~~Much wow~~ | <del>Much wow</del> |
Underline [1] | _So doge_ | <u>So doge</u> |
Quote [2] | "Such editor" | <q>Such editor</q> |
Highlight | ==So good== | <mark>So good</mark> |
Superscript | hoge^(fuga) | hogefuga |
Autolink | http://t.co | http://t.co |
Footnotes | [^4] and [^4]: | [3] and footnote 4 |
TeX-like 語法酣胀,數(shù)學(xué)計算式的表達(dá)
使用TeX-like數(shù)學(xué)語法, [4] 可以使用: \( 1 + 1 \) 或是 in MathML: <math><mn>1</mn><mo>+</mo><mn>1</mn></math>:
\[
A^T_S = B
\]
或是 (in MathML)
<math display="block">
<msubsup><mi>A</mi> <mi>S</mi> <mi>T</mi></msubsup>
<mo>=</mo>
<mi>B</mi>
</math>
列表顯示支持
- [x] 設(shè)置中選擇 task list syntax刁赦,才會生效
- [x] 支持嵌套
- [x] 支持順序和非順序方式
- [ ] 不支持香html一樣的checkbox選擇
-
如果 Underline 被禁用
_this_
將以 emphasized 加粗強(qiáng)調(diào)顯示娶聘,不顯示下滑線. ? -
引號 替換
"
符號使用 html<q>
標(biāo)簽. Quote 和 Smartypants 兩者是沖突的. 如果兩著都被棄用, 引號 優(yōu)先. 注意 quote引號與blockquote有區(qū)別的, 這也是標(biāo)準(zhǔn)的Markdown一部分. ? -
角注可以使用數(shù)字
[^4]
. 也可以使用[^footy note4]
和[^footy note4]:
此處帶:
號.無論如何標(biāo)示都會在角注中以數(shù)字序列排列,無論備注在何處都會在底部顯示. 不必特意編號甚脉,編輯器會自動為你按照角注順序編號丸升,并在底部顯示角注可以放到引用地方,但是最后會顯示在最后角注牺氨。 ? -
需要互聯(lián)網(wǎng)支持狡耻。 ?