Markdown 是一個 Web 上使用的文本到HTML的轉換工具,可以通過簡單、易讀易寫的文本格式生成結構化的HTML文檔。目前 github、Stackoverflow 等網站均支持這種格式。
區塊元素
標題
在行首插入1至6個#
,對應1到6階標題
# 標題 H1
## 標題 H2
### 標題 H3
#### 標題 H4
##### 標題 H5
###### 標題 H6
效果如下:
標題 H1
標題 H2
標題 H3
標題 H4
標題 H5
標題 H6
還有一種是用底線的形式,添加=
和-
來表示一階和二階標題
標題 H1
====
標題 H2
----
效果如下:
標題 H1
標題 H2
注意:在標題上方如果過是沒有樣式的純文字的話,需要增加換行
列表
Markdown 支持有序列表和無序列表。
無序列表使用*
、+
或是-
作爲列表標記:
* A站
* B站
* P站
效果如下:
- A站
- B站
- P站
有序列表則使用數字接着一個英文句點:
1. A站
2. B站
3. P站
效果如下:
- A站
- B站
- P站
列表項目標記通常是放在最左邊,但是其實也可以縮進,最多 3 個空格,項目標記後面則一定要接着至少一個空格或製表符。
區塊引用
只需要在添加在整個段落的第一行最前面加上>
,也可以根據層次加上不同數量的>
> Markdown 是一個 Web 上使用的文本到HTML的轉換工具,可以通過簡單、易讀易寫的文本格式生成結構化的HTML文檔。目前 github、Stackoverflow 等網站均支持這種格式。
>> 其實沒什麼用
效果如下:
Markdown 是一個 Web 上使用的文本到HTML的轉換工具,可以通過簡單、易讀易寫的文本格式生成結構化的HTML文檔。目前 github、Stackoverflow 等網站均支持這種格式。
其實沒什麼用
引用的區塊內也可以使用其他的 Markdown 語法,包括標題、列表、代碼區塊等:
> # 標題 H1
>
> 1. 這是第一行列表項。
> 2. 這是第二行列表項。
>
> 給出一些例子代碼:
>
> return shell_exec("echo $input | $markdown_script");
效果如下:
標題 H1
- 這是第一行列表項。
- 這是第二行列表項。
給出一些例子代碼:
return shell_exec("echo $input | $markdown_script");
代碼區塊
代碼區塊具有高亮效果,部分markdown的顯示還支持代碼風格顯示。使用 ```
單引號中間這三個點就可以開頭結束就可以顯示代碼塊
效果如下:
這是一個代碼區塊。
或者簡單地縮進4個空格或是1個製表符就可以,同樣對於沒有樣式的文本需要添加換行
效果如下:
這是一個普通段落:
這是一個代碼區塊。
代碼區塊中,一般的 Markdown 語法不會被轉換,像是星號便只是星號,這表示你可以很容易地以 Markdown 語法撰寫 Markdown 語法相關的文件。
分隔線
可以在一行中用三個以上的星號、減號、底線來建立一個分隔線,行內不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立分隔線:
* * *
***
*****
- - -
---------------------------------------
分割線效果如下:
注意:這裏能使用
-
,如果沒有和文字之間沒有換行隔開會顯示成二階標題
區段元素
鏈接
Markdown 支持兩種形式的鏈接語法: 行內式和參考式兩種形式,都是使用 []
來標記鏈接文字。
要建立一個行內式的鏈接,只要在方塊括號後面緊接着圓括號並插入網址鏈接即可,如果你還想要加上鍊接的 title 文字,只要在網址後面,用雙引號把 title 文字包起來即可,例如:
[簡書](http://jianshu.com "簡書")
[微博](https://weibo.com/)
而參考式的寫法則是有點像書的註解,在記鏈接名稱的方括號後面在添加一個[]
,而這個[]
中填寫的則是對應的鏈接;如果不填寫也可以根據鏈接名稱寫鏈接
爲了更清楚的表現參考式的語法,使用一段文字的形式來舉例,舉個栗子[嗶哩嗶哩][1] 和 [微博][] 是最近經常上的站點。
[1]: https://www.bilibili.com/ "嗶哩嗶哩"
[微博]: https://weibo.com/ "微博"
效果如下:
爲了更清楚的表現參考式的語法,使用一段文字的形式來舉例,舉個栗子嗶哩嗶哩 和 微博 是最近經常上的站點。
文字樣式
刪除線
在文字開始和結束的位置分別添加~~
~~這是加刪除線的文字~~
效果如下:
這是加刪除線的文字
加粗
在文字開始和結束的位置分別添加**
或者__
,這是兩個下劃線
**這是加粗的文字**
__這是加粗的文字__
效果如下:
這是加粗的文字
這是加粗的文字
斜體
在文字開始和結束的位置分別添加*
或者_
*這是傾斜的文字*
效果如下:
這是傾斜的文字
以上三種文字樣式可以通過嵌套對應的語法進行疊加
~~***這是加刪除線的文字***~~
效果如下:
這是加刪除線的文字
代碼
前面有提到代碼塊是使用在段落上的,代碼也可以給部分文本做標記,像這樣Flutter
也是可以的。使用反引號`
標記在需要標記的文本的開頭和結尾的位置
這是`代碼`行
效果如下:
這是代碼
行
如果要在代碼區段內插入反引號,就需要用多個反引號來標記開頭和結尾的位置
這是`` `代碼` ``行
效果如下:
這是`代碼`
行
圖片
圖片在簡書上就很簡單,直接上傳圖片就可以自動生成相應的語法。
![這是圖片標題](https://wx2.sinaimg.cn/mw690/89dea615gy1fj90roziyaj20g40g3gm6.jpg)
比較官方的說法是圖片支持參考式的寫法,但是我嘗試了一下鏈接的參考式寫法,在簡書上沒有辦法正常顯示圖片,所以就沒有寫相應的栗子了
其他
反斜槓
Markdown 可以利用反斜槓來插入一些在語法中有其它意義的符號,例如:如果你想要用星號加在文字旁邊的方式來做出強調效果,你可以在星號的前面加上反斜槓:
\*literal asterisks\*
效果如下:
*literal asterisks*
Markdown 支持以下這些符號前面加上反斜槓來幫助插入普通的符號:
\ 反斜線
` 反引號
* 星號
_ 底線
{} 花括號
[] 方括號
() 括弧
# 井字號
+ 加號
- 減號
. 英文句點
! 驚歎號
自動鏈接
Markdown 支持以比較簡短的自動鏈接形式來處理網址和電子郵件信箱,只要是用方括號包起來
<https://www.jianshu.com/u/70bd9fefe61f>
效果如下:
https://www.jianshu.com/u/70bd9fefe61f
而我嘗試過將<>
去掉也是可以的顯示成連接,但是我將https://www
刪除之後就無法直接顯示了,當讓加了<>
依然可以顯示。
表格
部分markdown的解析是可以顯示錶格的,這部分語法是參考馬克飛象的
表頭|表頭|表頭
---|:--:|---:
內容|內容|內容
內容|內容|內容
效果如下:
表頭 | 表頭 | 表頭 |
---|---|---|
內容 | 內容 | 內容 |
內容 | 內容 | 內容 |
甚至還有Markdown解析器能夠支持流程圖,但是很多都支持的不是很好
參考:Markdown中文網