1. 程式人生 > >.md即markdown文件的基本常用編寫語法

.md即markdown文件的基本常用編寫語法

裏的 .com 原理 多行 那種 數字 地址 在線 不同

因為現在的前端基本上都用上了前端構建工具,那就難免要寫一些readme等等的說明性文件,但是這樣的文件一般都是.md的文件,編寫的語法自然跟其他格式的文件有所區別,本文也是我學習寫markdown文件的一個筆記吧,僅供參考!

正文:

1、標題的幾種寫法:

第一種:

技術分享 技術分享

前面帶#號,後面帶文字,分別表示h1-h6,上圖可以看出,只到h6,而且h1下面會有一條橫線,註意,#號後面有空格

第二種:

技術分享 技術分享

這種方式好像只能表示一級和二級標題,而且=和-的數量沒有限制,只要大於一個就行

第三種:

技術分享 技術分享

這裏的標題支持h1-h6,為了減少篇幅,我就偷個懶,只寫前面二個,這個比較好理解,相當於標簽閉合,註意,標題與#號要有空格

那既然3種都可以使用,可不可以混合使用呢?我試了一下,是可以的,但是為了讓頁面標簽的統一性,不建議混合使用,推薦使用第一種,比較簡潔,全面

為了搞清楚原理,我特意在網上搜一下在線編寫markdown的工具,發現實際上是把這些標簽最後轉化為html標簽,如圖:

技術分享

在線地址請看這裏: markdown在線編輯 (只是想看看背後的轉換原理,沒有廣告之嫌)

2、列表

我們都知道,列表分為有序列表和無序列表,下面直接展示2種列表的寫法:

技術分享 技術分享

可以看到,無序列表可以用* , + , — 來創建,用在線編輯器看,實際上是轉換成了ul>li ,所以使用哪個都可以,推薦使用*吧

技術分享 技術分享

有序列表就相對簡單一點,只有這一種方式,註意,數字後面的點只能是英文的點,特別註意,有序列表的序號是根據第一行列表的數字順序來的,比如說:

技術分享 技術分享 技術分享 技術分享

第一組本來是3 2 1 倒序,但是現實3 4 5 ,後面一組 序號是亂的, 但是還是顯示 3 4 5 ,這點必須註意了

3、區塊引用

比如說,你想對某個部分做的內容做一些說明或者引用某某的話等,可以用這個語句

技術分享 技術分享

無序列表下方的便是引用,可以有多種用途,看你的需求了,用法就是在語句前面加一個 > ,註意是英文的那個右尖括號,註意空格

引用因為是一個區塊,理論上是應該什麽內容都可以放,比如說:標題,列表,引用等等,看看下圖:

技術分享 技術分享

將上面的代碼稍微改一下,全部加上引用標簽,就變成了一個大的引用,還有引用裏面還有引用,那引用嵌套引用還沒有別的寫法呢?

技術分享 技術分享

上圖可以看出,想要在上一次引用中嵌套一層引用,只需多加一個>,理論上可以無限嵌套,我就不整那麽多了,註意:多層嵌套的>是不需要連續在一起的,只要在一行就可以了,中間允許有空格,但是為了好看,還是把排版搞好吧

4、華麗的分割線

分割線可以由* - _(星號,減號,底線)這3個符號的至少3個符號表示,註意至少要3個,且不需要連續,有空格也可以

技術分享 技術分享

應該看得懂吧,但是為了代碼的排版好看,你們自己定規則吧,前面有用到星號,建議用減號

5、鏈接

支持2種鏈接方式:行內式和參數式,不管是哪一種,鏈接文字都是用 [方括號] 來標記。

技術分享 技術分享

上圖可知,行內式的鏈接格式是:鏈接的文字放在[]中,鏈接地址放在隨後的()中,舉一反三,經常出現的列表鏈接就應該這樣寫:

技術分享 技術分享

鏈接還可以帶title屬性,好像也只能帶title,帶不了其他屬性,註意,是鏈接地址後面空一格,然後用引號引起來

技術分享

這是行內式的寫法,參數式的怎麽寫:

技術分享 技術分享

這就好理解了,就是把鏈接當成參數,適合多出使用相同鏈接的場景,註意參數的對應關系,參數定義時,這3種寫法都可以:

[foo]: http://example.com/ "Optional Title Here"

[foo]: http://example.com/ ‘Optional Title Here‘

[foo]: http://example.com/ (Optional Title Here)

還支持這種寫法,如果你不想混淆的話:

[foo]: <http://example.com/> "Optional Title Here"

其實還有一種隱式鏈接的寫法,但是我覺得那種寫法不直觀,所以就不寫了,經常用的一般就上面2種,如果你想了解隱式鏈接,可以看我文章最後放出的參考地址

6、圖片

圖片也有2種方式:行內式和參數式,

技術分享 技術分享

用法跟鏈接的基本一樣,唯一的不同就是,圖片前面要寫一個!(這是必須的),沒什麽好說的

7、代碼框

這個就比較重要了,很多時候都需要展示出一些代碼

如果代碼量比較少,只有單行的話,可以用單反引號包起來,如下:

技術分享 技術分享

要是多行這個就不行了,多行可以用這個:

技術分享 技術分享

多行用三個反引號,如果要寫註釋,可以在反引號後面寫

8、表格

這個寫的有點麻煩,註意看

技術分享 技術分享

從這3種不同寫法看,表格的格式不一定要對的非常起,但是為了好看,對齊肯定是最好的,第一種的分割線後面的冒號表示對齊方式,寫在左邊表示左對齊,右邊為右對齊,兩邊都寫表示居中,還是有點意思的,不過現實出來的結果是,表格外面並沒有線框包起來,不知道別人的怎麽弄的

9、強調

技術分享 技術分享

一個星號或者是一個下劃線包起來,會轉換為<em>傾斜,如果是2個,會轉換為<strong>加粗

10、轉義

技術分享 技術分享

就不一一列舉了,基本上跟js轉義是一樣的

11、刪除線

技術分享 技術分享

常用的基本上就這些了,如果還有一些常用的,可以跟我留言,我補充上去,我覺得圖文並茂才是高效學習的正確姿勢,但願為你的學習帶來幫助!

.md即markdown文件的基本常用編寫語法