標籤:

Markdown: Basics (快速入門)

Getting the Gist of Markdowns Formatting Syntax

此頁提供了 Markdown 的簡單概念, 語法說明 頁提供了完整詳細的文檔,說明了每項功能。但是 Markdown 其實很簡單就可以上手,此頁文檔提供了一些範例,並且每個範例都會提供輸出的 HTML 結果。

其實直接試試看也是一個很不錯的方法, Dingus 是一個網頁應用程序,你可以把自已編寫的 Markdown 文檔轉成 XHTML。

段落、標題、區塊代碼

一個段落是由一個以上的連接的行句組成,而一個以上的空行則會劃分出不同的段落(空行的定義是顯示上看起來像是空行,就被視為空行,例如有一行只有空白和 tab,那該行也會被視為空行),一般的段落不需要用空白或換行縮進。

Markdown 支持兩種標題的語法,Setext 和 atx 形式。Setext 形式是用底線的形式,利用 = (最高階標題)和 - (第二階標題),Atx 形式在行首插入 1 到 6 個 # ,對應到標題 1 到 6 階。

區塊引用則使用 email 形式的 > 角括弧。

Markdown 語法:

A First Level Headern====================nA Second Level Headern---------------------nnNow is the time for all good men to come tonthe aid of their country. This is just anregular paragraph.nnThe quick brown fox jumped over the lazyndogs back.n### Header 3nn> This is a blockquote.n> n> This is the second paragraph in the blockquote.n>n> ## This is an H2 in a blockquoten

輸出 HTML 為:

<h1>A First Level Header</h1>n<h2>A Second Level Header</h2>n<p>Now is the time for all good men to come tonthe aid of their country. This is just anregular paragraph.</p>n<p>The quick brown fox jumped over the lazyndogs back.</p>n<h3>Header 3</h3>n<blockquote>n<p>This is a blockquote.</p>n<p>This is the second paragraph in the blockquote.</p>n<h2>This is an H2 in a blockquote</h2>n</blockquote>n

修辭和強調

Markdown 使用星號和底線來標記需要強調的區段。

Markdown 語法:

Some of these words *are emphasized*.nSome of these words _are emphasized also_.nUse two asterisks for **strong emphasis**.nOr, if you prefer, __use two underscores instead__.n

輸出 HTML 為:

<p>Some of these words <em>are emphasized</em>.nSome of these words <em>are emphasized also</em>.</p>n<p>Use two asterisks for <strong>strong emphasis</strong>.nOr, if you prefer, <strong>use two underscores instead</strong>.</p>n

列表

無序列表使用星號、加號和減號來做為列表的項目標記,這些符號是都可以使用的,使用星號:

* Candy.n* Gum.n* Booze.n

加號:

+ Candy.n+ Gum.n+ Booze.n

和減號

- Candy.n- Gum.n- Booze.n

都會輸出 HTML 為:

<ul>n<li>Candy.</li>n<li>Gum.</li>n<li>Booze.</li>n</ul>n

有序的列表則是使用一般的數字接著一個英文句點作為項目標記:

1. Redn2. Greenn3. Bluen

輸出 HTML 為:

<ol>n<li>Red</li>n<li>Green</li>n<li>Blue</li>n</ol>n

如果你在項目之間插入空行,那項目的內容會用 <p> 包起來,你也可以在一個項目內放上多個段落,只要在它前面縮排 4 個空白或 1 個 tab 。

* A list item.nn With multiple paragraphs.nn* Another item in the list.n

輸出 HTML 為:

<ul>n<li><p>A list item.</p>n<p>With multiple paragraphs.</p></li>n<li><p>Another item in the list.</p></li>n</ul>n

鏈接

Markdown 支援兩種形式的鏈接語法: 行內 和 參考 兩種形式,兩種都是使用角括弧來把文字轉成連結。

行內形式是直接在後面用括弧直接接上鏈接:

This is an [example link](http://example.com/).n

輸出 HTML 為:

<p>This is an <a href="http://example.com/">nexample link</a>.</p>n

你也可以選擇性的加上 title 屬性:

This is an [example link](http://example.com/ "With a Title").n

輸出 HTML 為:

<p>This is an <a href="http://example.com/" title="With a Title">nexample link</a>.</p>n

參考形式的鏈接讓你可以為鏈接定一個名稱,之後你可以在文件的其他地方定義該鏈接的內容:

I get 10 times more traffic from [Google][1] than fromn[Yahoo][2] or [MSN][3].nn[1]: http://google.com/ "Google"n[2]: http://search.yahoo.com/ "Yahoo Search"n[3]: http://search.msn.com/ "MSN Search"n

輸出 HTML 為:

<p>I get 10 times more traffic from <a href="http://google.com/"ntitle="Google">Google</a> than from <a href="http://search.yahoo.com/"ntitle="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"ntitle="MSN Search">MSN</a>.</p>n

title 屬性是選擇性的,鏈接名稱可以用字母、數字和空格,但是不分大小寫:

I start my morning with a cup of coffee andn[The New York Times][NY Times].nn[ny times]: http://www.nytimes.com/n

輸出 HTML 為:

<p>I start my morning with a cup of coffee andn<a href="http://www.nytimes.com/">The New York Times</a>.</p>n

圖片

圖片的語法和鏈接很像。

行內形式(title 是選擇性的):

![alt text](/path/to/img.jpg "Title")n

參考形式:

![alt text][id]nn[id]: /path/to/img.jpg "Title"n

上面兩種方法都會輸出 HTML 為:

<img src="/path/to/img.jpg" alt="alt text" title="Title" />n

代碼

在一般的段落文字中,你可以使用反引號 ` 來標記代碼區段,區段內的 &、< 和 > 都會被自動的轉換成 HTML 實體,這項特性讓你可以很容易的在代碼區段內插入 HTML 碼:

I strongly recommend against using any `<blink>` tags.nnI wish SmartyPants used named entities like `—`ninstead of decimal-encoded entites like `—`.n

輸出 HTML 為:

<p>I strongly recommend against using anyn<code><blink></code> tags.</p>n<p>I wish SmartyPants used named entities liken<code>—</code> instead of decimal-encodednentites like <code>—</code>.</p>n

如果要建立一個已經格式化好的代碼區塊,只要每行都縮進 4 個空格或是一個 tab 就可以了,而 &、< 和 > 也一樣會自動轉成 HTML 實體。

Markdown 語法:

If you want your page to validate under XHTML 1.0 Strict,nyouve got to put paragraph tags in your blockquotes:nn<blockquote>n<p>For example.</p>n</blockquote>n

輸出 HTML 為:

<p>If you want your page to validate under XHTML 1.0 Strict,nyouve got to put paragraph tags in your blockquotes:</p>n<pre><code><blockquote>n<p>For example.</p>n</blockquote>n</code></pre>n

推薦閱讀:

前端的學習之路-markdown語法
用簡書作 Markdown 圖床
Stata連享會:Markdown 筆記
#R語言#Rstudio+Rmarkdown+latex輸出自動化報告

TAG:Markdown语法 |