1/30/2015

Hello Markdown

Markdown 是一種網路寫作語言,屬於輕量級的標記語言1,它好處就是書寫和閱讀起來一樣容易。在文字編輯的部份,除了可以採用一般的純文字編輯器來撰寫,並透過一些適當的工具轉換成網頁發佈外,亦可以直接採用專用的編輯器來書寫,在編輯之餘還可以即時預覽轉換成網頁的結果,以上,這些工具的出處我想 Google 大神應該會很樂替你回答。

本部落的文章主要是採用 StackEdit2 編輯器來撰寫,並發佈至 Blogger 上,為了維持版面的一致性,在 CSS 和 JS 上也採用與 StackEdit 相通的規則,並且只有在極少數的情況3下才會編輯原生的 HTML 語法,下面就針對一些 Markdown 語法4做介紹,並且測試 Blogger 的格式正確與否。


標題

Markdown 支援 Setext 和 Atx 兩種標題語法格式。
使用任何數量的 - 和 = 符號於文字底部創造高階與次階標題,如果你和我一樣有強迫症,也可以使符號的數量等同於標題文字的長度,也有助於閱讀。 Atx 方面,則是在標題文字前方使用 1 至 6 個 # 符號來表示不同的標題階層,符號與標題文字中間即使存在著空白字元也無所謂,另外,在文字後方的 # 加與不加,則是隨個人喜好。

Setext

高階標題(H1)
===========

次階標題(H2)
-----------

Atx

# 高階標題(H1)

## 次階標題(H2)

### 再次階標題(H3)

強調文字

使用 * 或 _ 符號將強調文字包覆其中,單一符號表示斜體,兩個連續符號表示粗體。

Markdown

*斜體文字*
**粗體文字**
_斜體文字_
__粗體文字__

連結

一般形式超連結

超連結使用 [ ] 方括號將連結文字放置其中,並且使用 ( ) 括號放置連結的網址,如果需要針對連結的內容加以解說,可在 ( ) 括號中以 " " 雙引號標示之,解說的內容會在滑鼠停留於連結文字時呈現。

Markdown

MILKDOWN Bloggr [由此進](http://milkdown.blogspot.tw/ "MILKDOWN")

MILKDOWN Bloggr 由此進

如果你的連結網址與連結文字完全相同,你可以直接使用網址當做文字,或使用 < > 角括號將網址放置其中,而這種簡短的表示方式無法為超連結提共任何註解。

Markdown

<http://milkdown.blogspot.tw/>

http://milkdown.blogspot.tw/

參考形式超連結

參考形式的使用方式很像在寫論文時的參考文獻,它包含兩部分* 定義與使用*,而這兩部分可以分開撰寫,你可以將所有參考形式的定義通通置於文末方便管理。
參考形式超連結在超連結的使用上同樣是以 [ ] 方括號將連結文字放置其中,並且隨後面再使用一組 [ ] 方括號放置參考的定義名稱。至於猜考形式定義的寫法請參考以下作法:

Markdown

MILKDOWN Bloggr [由此進][milkdown]
Furnace iOS [由此進][furnace]

[milkdown]: http://milkdown.blogspot.tw/ "MILKDOWN"
[furnace]: http://furnacedigital.blogspot.tw/

MILKDOWN Bloggr 由此進
Furnace iOS 由此進

內文註釋連結

註釋的使用上與參考形式相當類似,屬於文章內的錨點,差別在於註釋需再方誇號內增加一個上標做為標示 [^ ] ,同樣你可以在文內的任何地方對這個註釋下定義,但是不論你在何處定義註釋的內容,最後轉成 HTML 時,它永遠只會出現在文章末端,並且自動以使用的順序做標示。

Markdown

註釋[^note]

[^note]: 不論你在何處定義註釋的內容,最後轉成 HTML 時,它永遠只會出現在文章末端,並且自動以使用的順序做標示。 

註釋5

注意:不管是使用參考形式或是註釋時,在定義的命名上都應該使用英文數字,因為使用中文有可能導致在轉換 HTML 時發生錯誤。

圖片連結

圖片的格式使用 ![ ] 驚嘆號配合方括號,並在方括號中放入想要的替代文字,於後面接上一般形式超連結的 ( ) 括號,或是參考形式超連結的 [ ] 方括號表示方式。

Markdown

![替代文字](http://markdown.tw/images/208x128.png "Markdown")

![](http://markdown.tw/images/208x128.png)

![][image]
[image]: http://markdown.tw/images/208x128.png

備註:目前在 Markdown 中還無法直接對圖片做定位或編輯大小的處理,如果需要這些功能還必須仰賴 HTML 的 < img > 標籤。


區塊

使用 Markdown 可以快速的替文字建立區塊標籤,像是文字的背景或是在電子郵件與論壇中常見的引言和程式碼區塊等等。

單行程式碼區塊

對單行內的文字使用程式碼標註,只需在文字前後搭配 ` 反引號符號即可,在轉譯成 HTML 時會以 <code> 標籤標示。

多行程式碼區塊

同樣在轉譯成 HTML 時,此處會以 <code> 標籤標示,在使用上,必須在段落頭尾加上 ``` 三個反引號符號,才能建立此區塊。

Markdown

 `stdio.h`

 ```
 // Foo 
 var bar = 0;
 ``` 

stdio.h

 // Foo 
 var bar = 0;

引言

使用 > 角括號來代表引言,引言也包含階層,例如是引言的引言,這時可以使用數個 > 角括號來標示,而在引言內仍然可以使用任何 Markdown 語法來書寫。

Markdown

>引言
>>引言內的引言
>>>引言內的引言內的引言...

引言

引言內的引言

引言內的引言內的引言…

分格線

使用三個以上的 * 、 - 、 _ 符號來製作分格線劃分整個頁面,在使用上為了避免與標題字級的混淆, --- 上方不能存在任何非空白字元。

Markdown

//以下三種形式都可以繪製分隔線
---
***
___

清單

清單在文字的表達上也相當重要,它可以簡潔又清楚的讓閱讀者知道想要傳達的訊息, Markdown 在清單的表示上可以使用 * 、 - 、 + 等符號製作無序號的清單,或是使用 1. 、 2. 、 3. 等阿拉伯數字還呈顯序號清單,並且搭配按鍵 space 或 tab 來製作具有階層樣式的清單。

Markdown

1. 項目A
- 子項目
2. 項目B
    1. 子項目 B1
    2. 子項目 B2
    - 細項
3. 項目C  
  1. 項目A
    • 子項目
  2. 項目B
    1. 子項目 B1
    2. 子項目 B2
      • 細項
  3. 項目C

注意:在使用阿拉伯數字製作具有順序的清單時,若不按照數字順序建立清單,在轉成 HTML 時,仍會強制變更為既定順序。

另外,如果你的清單不需要如此複雜的階層關係,也可以使用 : 來建立縮排的子項目。

Markdown Extra

項目
: 子項目
項目
子項目

表格

Markdown 也可以用來繪製簡單表格,它的書寫方式也同樣非常直覺,並且使用 : 做簡單的整行對齊。

Markdown Extra

項目  | 內容
-----|----
項目A | A
項目B | B
項目C | C
項目 內容
項目A A
項目B B
項目C C

Markdown Extra


|項目  | 內容 | 類型 |
|:-----|:----:|---:|
|項目A | A    | a  |
|項目B | B    | b  |
|項目C | C    | c  |
項目 內容 類型
項目A A a
項目B B b
項目C C c

數學方程式

數學方程式必須透過 TeX/LaTeX 語法表示法做排版,排版結果要正常顯示在網頁上的話還必須使用 MathJax 來達成,使用 $ 字串在包覆數學式於單行文字中,或是使用 $$ 來產生一個書寫方程式的區塊。

Markdown Extra / LaTeX

在單行文字內使用 $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ 數學方程式

在單行文字內使用 數學方程式

Markdown Extra / LaTeX

$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$

備註:你可以在 meta.math.stackexchange.com 找到更多有關使用 LaTeX 撰寫數學方程式的方法。


UML

你可以在多行的程式碼區塊上使用標記 sequence 或 flow 來分別繪製循序圖與流程圖。

循序圖

Markdown Extra

 ```sequence
 Alice->Bob: Hello Bob, how are you?
 Note right of Bob: Bob thinks
 Bob-->Alice: I am good thanks!
 ```
Created with Raphaël 2.1.2AliceAliceBobBobHello Bob, how are you?Bob thinksI am good thanks!

流程圖

Markdown Extra

 ```flow
 st=>start: Start
 e=>end
 op=>operation: My Operation
 cond=>condition: Yes or No?

 st->op->cond
 cond(yes)->e
 cond(no)->op
 ```
Created with Raphaël 2.1.2StartMy OperationYes or No?Endyesno

備註:你可以在這裡找到更多有關 循序圖與流程圖的撰寫方法。


自動列表

使用 [TOC] 可以快速且有效的替整篇文章列表,列表中的文字與格式取決於文章中所有字級的使用。

Markdown Extra

[TOC]


  1. 在 Markdown 之前就有 HTML(HyperText Markup Language),這也是大家所熟悉的超文件標示語言,但是它並不輕量也不易閱讀。 ↩
  2. StackEdit 是一個基於網頁的 Markdown 編輯器,除此之外還提供許多存檔與同步的機制,在發佈上除了本機外,也可以與線上的眾多服務整合,相當方便。 ↩
  3. Markdown 畢竟是以純文字為基礎的語言,在書寫與閱讀上達成一致,因此在處片的處理,或是一些特殊的效果上並沒有非常良好的支援。 ↩
  4. 文內所有的 Markdown 語法並不是所有的編輯器都能正常轉譯成 HTML,在顯示上的效果也須搭配特定的 CSS 來呈現。 ↩
  5. 不論你在何處定義註釋的內容,最後轉成 HTML 時,它永遠只會出現在文章末端,並且自動以使用的順序做標示。 ↩