markdown中文語法說明

概述

宗旨

<p>Markdown 的目標是實現【易讀易寫】。</p>
<p>可讀性,無論如何都是最重要的。一份使用Markdown 格式撰寫的文件應該可以直接以純文本發布,并且看起來不會是由很多標簽或是格式命令組成。Markdown 語法受到一些既有 text-HTML 格式的影響,而最大靈感其實是純文本電子郵件格式的影響。</p>
總之,Markdown 的語法全由一些符號組成,這些符號經過精挑細選,其作用一目了然。比如:在文字兩旁加上星號(*),看起來就是強調。Markdown 的列表看起來,嗯,就是列表。Markdown 的區塊引用看起來就像是引用一段文字。

兼容HTML

<p>Markdown 語法的目標是:成為一種適用于網絡的<em>書寫</em>語音。</p>
<p>Markdown 不是要取代 HTML,甚至也不是要和它接近。它的語法種類很少,只占 HTML 標記的一小部分。Markdown 的構想<em>不是</em>要使得 HTML 更易書寫。Markdown的理念是,能讓文檔更容易讀、寫和隨意改。HTML 是一種<em>發布</em>的格式,Markdown 是一種<em>書寫</em>的格式。就這樣,Markdown 的格式語法只覆蓋純文本可以涵蓋的范圍。</p>
<p>不在 Markdown 涵蓋范圍之內的標簽,都可以直接在文檔里面用 HTML 撰寫。不需要額外標注這是 HTML 或是 Markdown ;只要直接加標簽就可以了。</p>
<p>要制約的只有一些 HTML 區塊元素—比如 '<div>'、 <code><table></code> 等標簽,必須要在前后加上空行與其他內容區隔開,還要求它們的開始標簽與結尾標簽不能用制表符或空格來縮進。</p>
<p>例子如下,在 Markdown 文件里加上一段 HTML 表格:</p>
<pre><code>這是一個普通段落。
<table>
<tr>
<td>Foo</td>
</tr>
</table>
這是另一個普通段落。
</code></pre>
<p>請注意,在 HTML 區塊標簽間的 Markdown 格式語法將不會被處理。比如,你在 HTML 區塊內使用 Markdown 樣式的強調會沒有效果。</p>
HTML 的區段(行內)標簽如<code><span></code>、<code><del></code> 可以在Markdown 的段落、列表或是標題里隨意使用。依照個人習慣,甚至直接可以用 HTML 標簽來格式化。舉例說明,如果比較喜歡 HTML 的<code><<img>></code>標簽,可以直接使用這些標簽,而不用 Markdown 提高的鏈接或是圖像標簽語法。</p>
<p>和處在 HTML 區塊標簽間不同,Markdown 語法在 HTML 區段標簽間是有效的。</p>

特殊字符自動轉換

在 HTML 文件中,有兩個字符需要特別處理:<code><</code>、<code>&</code> 。<code><</code> 用于起始標簽,<code>&</code> 用于標記 HTML 實體。如果你只是要使用這個符號,你必須要使用實體的形式,比如,像是 < 、& 。

<code>&</code> 字符尤其讓網絡文檔編寫者受折磨,如果你要打 AT&T, 你必須要寫成 ‘AT&T’ 。而網址中的 & 也要轉換。如果要鏈接到:
http://images.google.com/images?num=30&q=larry+bird
你必須把網址轉換寫為
http://images.google.com/images?num=30&q=larry+bird
才能放到鏈接標簽的 href 屬性里。不用說也知道這很容易忽略。這也可能是 HTML 標準檢驗所檢查到的錯誤中,數量最多的。

Markdown 讓你可以自然地書寫字符,需要轉換的由它來處理就好了。如果你使用的 & 字符是 HTML 字符實體的一部分,它會保留原狀,否則它會轉換成 &

所以,如果要在文檔中插入一個版權符號?,你可以這樣寫:
?
Markdown 會保留它不動。

需要注意的是, code 范圍內,不論是行內還是區塊, <& 兩個符號都一定會被轉換成 HTML 實體,這項特性讓你可以用 Markdown 寫 HTML code 。

區塊元素

段落和換行

<p>一個 Markdown 段落是由一個或多個連續的文本行組成,它的前后要有一個以上的空行(空行的定義是顯示上看起來像是空的,便會被視為空行。比如,若某一行只含空格和 Tab, 則該行業將視為空行)。普通段落不該用空格或 Tab 來縮進。</p>

「一個以上相連接的行句組成」這句話其實暗示了 Markdown 允許段落內的強迫斷行,這個特性和其他大部分的 text-to-HTML 格式不一樣(包括 MovableType 的「Convert Line Breaks」選項),其它的格式會把每個斷行都轉成 <br /> 標簽。

標題

區塊引用

Markdown 標記區塊引用是使用類似 email 中用 > 的引用方式。

This is a blockquote with two paragraphs.

Markdown也允許你偷懶只在整個段落的第一行最前面加上> :

區塊引用可以嵌套,只要根據層次加上不同數量的 > :

This is the first level of quoting.

This is nested blackquote.

Back to the first level.

引用的區塊內也可以使用其他的 Markdown 語法,包括標題、列表、代碼區塊等:

This is a header.

  1. This is the first list item.
    
  2. This is the second list item.
    

Here's some example code:

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

清單

Markdown 支持有序清單和無序清單。

無序清單使用星號、加號或減號作為清單標記。
* red
* green
* purple

等同于:

  • red
  • green
  • purple

也等同于

  • red
  • green
  • purple

有序清單則使用數字接著一個英文句點:

  1. bird
  2. McHale
  3. Parish

要讓清單看起來更漂亮,你可以把內容用固定的縮排整理好:

  • 《 Fantastic animals 》is an impressive movie i have  
      watched in this year.
    
  •  《神奇動物在哪里》這部電影讓我印象深刻,里面的 
      魔法生物各有各的特點。
    

如果清單項目用空行隔開,Markdown 會把項目內容在輸出時用<p>標簽包起來,舉例來說:

  • Bird

  • Magic

會被轉換為:

<ul>
<li>Bird</li>
<li><p>Magic</p></li>
</ul>

項目清單很有可能會不小心產生,如:
1986.It is a great season.
換句話說,在行首出現 數字-句號-空白 ,要避免這樣的情況,可以在數字后加斜線:
1986/. It is a great season.

程序區塊

和程序相關的寫作或者標記語言原始代碼通常會有已經排版好的程序區塊,通常這些區塊我們并不希望它以一般段落文件的形式去排版,而是原來的樣子。Markdown 會用<pre><code>把程序區塊包起來。

要在 Markdown 中建立程序區塊很簡單,只要縮排4個空白或是1個tab即可。

分隔線

用三個以上的星號、減號、底線來建立一個分隔線,行內不能有其他東西。


-----



區內要素

鏈接

Markdown 支持行內參考兩種形式的鏈接語法。不管是哪一種,鏈接的文字都是用[方括號]來標記。

要建立一個行內形式的鏈接,只需要在方括號的后面馬上接著括號并插入網頁鏈接即可,如果你還想要加上鏈接的 title 文字,只要在網址后面,用雙引號把 title 文字包起來即可。

參與形式的鏈接使用另外一個方括號接在鏈接文字的括號后面,而在第二個方括號后面要填入用以辨別鏈接的標簽。接著,在文章的任意處,你可以把這個標簽的鏈接內容定義出來。
鏈接定義的形式為:

  • 方括號,里面輸入鏈接的辨識用標簽
  • 接著一個冒號
  • 接著一個以上的空白或tab
  • 接著鏈接的網址
  • 選擇性地接著title內容,可以用單引號、雙引號或者括弧包著

你也可以把title屬性放到下一行,也可以加一些縮排,網址太長的話,這樣比較美觀。
舉例:
I get 10 traffics from Google than from [Yahoo] [2] or [MSN] [3].
1: http://google.com "Google"
[2]: http://search.yahoo.com "Yahoo"
[3]: http://search.msn.com "MSN"

強調

Markdown 使用星號()和底線(_)作為標記強調字詞的符號,被 * 或 _ 包圍的字詞會被轉換成用<em>標簽包圍,用兩個 或 _ 包圍的字詞會被轉換成<strong>.

但是如果*_兩邊都有空白的話,他們就只會看被當做普通的符號。

如果要在文字前后直接插入普通的星號或底線,可以用反斜線:
\這段文字沒有被強調\

圖片

圖片與鏈接的插入方法相似,只是在鏈接的語法前加上了

注:本文內容引用自 Markdown語法說明繁體版, 練習Markdown語法所用。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,606評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,582評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,540評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,028評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,801評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,223評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,294評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,442評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,976評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,800評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,996評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,543評論 5 360
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,233評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,926評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,702評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374

推薦閱讀更多精彩內容