MarkDown語法簡要匯總筆記

標題

  1. setext形式即用底線形式:最高級標題(=),二級標題(-)任何數量的‘=’和‘-’效果一樣。

這是一級標題 ========
展示方式:
這是一級標題
=======

  1. atx形式:在行首插入1~6個'#',分別對應1~6級標題(行尾的‘#’與效果無關)。

# 這是一級標題 #
展示方式:

這是一級標題

區(qū)塊引言

  1. 在MD文件中建立一個區(qū)塊引言,看起來像是強迫斷行,然后在每行最前面加‘>’,并且可循環(huán)套用。:

> 區(qū)塊引言文本1
> > 子區(qū)塊引言文本2
展示方式:

區(qū)塊引言文本1

子區(qū)塊引言文本2

  1. 區(qū)塊引言也允許在整個段落的第一行最前面加上‘>’:

> 這是個段落 段落中的詳細文本。 blablabla。
展示方式:

這是個段落
段落中的詳細文本。
blablabla。

  1. 區(qū)塊引言中亦可使用其它MD語法,包括標題、清單、程式等:

> ## 二級標題
>
> 1. 有序列表1.
> 2. 有序列表2
>
> 代碼實例:
>
> return shell_exec("echo $input | $markdown_script");
** 展示方式: **

二級標題

  1. 有序列表1.
  2. 有序列表2

代碼實例:

return shell_exec("echo $input | $markdown_script");

清單

_ MD支持有序列表無序列表。_

  1. 無序列表使用*+-作為清單標記。(混用亦可)

* red
+ Green
- blue
** 展示方式: **

  • red
  • Green
  • blue
  1. 有序列表使用數字接著一個英文句點

1. Bird
2. McHale
3. Parish
** 展示方式: **

  1. Bird
  2. McHale
  3. Parish

可以讓MD文件的清單數字和輸出的結果一致,也可不一致,即隨意輸入數字;

建議從1.開始,因為MD未來可能會有序列表的start屬性。

  1. 關于清單列表的縮排:
  • 清單標記通常放在最左邊,其實亦可縮排,最多3個空白,但標記后面一定要接著至少一個空白tab
  • 清單項目可以包含多個段落,每個項目下的段落都必須縮排4個空白或是一個tab
  • _在行首出現不預知的數字-句點-空白情況,可以在句點前加反斜杠\\避免。 _

* 這是第一行文本。
(加3個空白或者tab)這是第二行文本。
** 展示方式 **

  • 這是第一行文本。
    這是第二行文本。
  1. 清單內引用區(qū)塊引言,則>需要縮進:

* 在清單中內置區(qū)塊引用:
(空白或tab) > 需要縮排
** 展示方式: **

  • 在清單中內置區(qū)塊引用:

    > 需要縮排

  1. 如果要放程式區(qū)塊的話,該區(qū)塊引言就要縮排2次,即8個空白2個tab:

* 列表中放入代碼:
(2個tab或8個空白縮進)代碼在這里
** 展示方式: **

  • 列表中放入代碼:
    NSLog(@"hello world");

代碼區(qū)塊

  1. 代碼或者標識語言原始碼寫作通常已經有排版好的區(qū)塊。故我們并不希望它以一般段落文本的方式去排版,而是原樣輸出即可。
  2. MD自動會用<pre><code>標識來將代碼塊包起來。
  3. _在程式碼區(qū)塊裡面,&、<和>會自動轉成HTML實體,這樣的方式讓你非常容易使用Markdown插入範例用的HTML原始碼,只需要複製貼上,再加上縮排就可以了,剩下的Markdown都會幫你處理,
  4. 在MD中建立代碼區(qū)塊,只要簡單的** 縮排4個空白1個tab即可。 **_ (一個代碼塊會一直持續(xù)到沒有縮排的那一行) _ :

下面是個代碼區(qū)塊展示:
(4個空白或1個tab)NSLog(@"hello world") ;
**展示方式: **
下面是個代碼區(qū)塊展示:
NSLog(@"hello world") ;
NSLog(@"hello china") ;

    _ 附錄:程式碼區(qū)塊中,一般的Markdown語法不會被轉換,像是星號便只是星號,這表示你可以很容易地以Markdown語法撰寫Markdown語法相關的文件。_

分割線

  1. 可在一行中用3個或者以上的*-_來建立一個分割線,但行內不能有其它元素。
    _亦可在*中間插入空白,均可建立分割線。
  2. 本示例以及下文中的MD原始語法,均以代碼塊的形式展示
 * *   *
 ***
 ***********
 --      --
 -*_
 ____

**展示方式: **





-*_


區(qū)段元素

  1. MD支持2種形式的鏈接語法:行內鏈接參考鏈接
  2. 鏈接的文字均是用[鏈接文字]來標識。
  行內鏈接
  這是 [示例1](http://www.baidu.com/ "title") inline link.
 [示例2](http://www.baidu.com/)沒有title屬性。

 連接同主機的資源,可以使用相對路徑:
 點擊關于 [About](/about) 查看詳情。

 參考形式的鏈接:
 1. 使用另外一個[]接在鏈接文字的方括號后面,而在第二個[]里面要填入用以鏈接的標簽。
 2. 然后在文件的其它任意處,把[id]標簽鏈接內容定義出來。

 這是個 [參考鏈接][1] 的鏈接。
 定義[id]
 [a]:  http://www.baidu.com  "title"

** 展示方式: **
這是 示例1 inline link.
示例2 無title屬性。

點擊關于 About 查看詳情。

這是個 [參考鏈接] [a] 的鏈接。
[a]: http://www.baidu.com "title"

強調

  1. MD使用*_作為標記強調字詞的符號。符號和文本之間不留空白
 **`\*\*` 號展示著重文本形式**
 _ `_`號展示斜體文本形式 _

 **`\*\*` 號展示著重文本形式**
 __`\_\_`號展示著重文本形式__

** 展示方式: **

\*號展示斜體文本形式

\_號展示斜體文本形式

\*\* 號展示著重文本形式

\_\_號展示著重文本形式

代碼

  1. 若要標記一小段行內代碼,可以用\`號將其包起來:
 文本中間有代碼:`NSLog(@"hello world");` 的MD標識方式。

** 展示方式: **

文本中間有代碼:NSLog(@"hello world"); 的MD標識方式。

圖片

  1. MD使用一種和鏈接很相似的語法來標記圖片。同樣也允許有2種樣式:行內參考
  • (** 目前為止,無法指定圖譜安的寬高,如需要,則使用普通的 <img>標簽 **)

行內:
![alet 文本] (/path/to/img.jpg)
![alet 文本] (/path/to/img.jpg "title")
** 展示如下:
! [alet] (/path/to/img.jpg)
! [alet 文本] (/path/to/img.jpg "title")

參考:
! [alert text] [id]
[id]: url/to/image "title"
** 展示 **
! [alert text] [a]
[a]: url/to/image "title"

其他

  1. 自動鏈接(MD支持簡短的自動鏈接,以處理網址和email地址)
 <http://www.baidu.com>

**展示: **
http://www.baidu.com

郵箱:
<address@e_mail.com>
** 展示: **
<address@e_mail.com>

跳脫字元

  1. MD可以利用 \來插入一些在語法中有其它意義的符號。如將*號置于文字旁邊顯示強調效果:
 \*  這是個顯示強調效果的文本。 \* (此處無效果,待查)

** 展示 **
*這是個顯示強調效果的文本。*

Markdown支援在下面這些符號前面加上反斜線來幫助插入普通的符號:

 \   反斜線
 `   反引號
 *   星號
 _   底線
 {}  大括號
 []  方括號
 ()  括號
 #   井字號
 +   加號
 -   減號
 .   英文句點
 !   驚嘆號

附:

  • 本文參考自 Markdown 語法說明
  • 本文僅是參考文檔的縮略版,方便自己快速查找語法的使用。隨著自己不斷的運用md工具,本文將不斷積累。
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Markdown: Syntax 概述 哲學 行內 HTML 特殊字符自動轉換 區(qū)塊元素 段落和換行 標題 區(qū)塊引...
    未知代碼閱讀 7,541評論 6 50
  • 為什么學習Markdown 自從搭建了 Hexo 博客之后,發(fā)現還有 Markdown 這種寫文章的方法,想到以后...
    lifeColder閱讀 20,194評論 10 216
  • Markdown 語法 之劍 2016.5.3 23:41:46 hljs.initHighlightingOnL...
    光劍書架上的書閱讀 1,648評論 1 5
  • 說明:本文原載于圖靈社區(qū)網站,本次轉載時為方便閱讀,并修改個別用語。 Markdown: Syntax 概述 哲學...
    tonyzheng1閱讀 777評論 0 49
  • Markdown 語法說明 (簡體中文版) 概述宗旨兼容 HTML特殊字符自動轉換 區(qū)塊元素段落和換行標題區(qū)塊引用...
    蚊子Skeeter閱讀 3,219評論 3 12