2011年6月28日

Markdown Syntax 易讀易寫的文件撰寫格式

Markdown 的目標就是易讀易寫 (easy-to-read, easy-to-write)。

Markdown: Syntax 是由 John GruberAaron Swartz 兩位老兄建立的一種純文字格式,它是「輕量級標記語言(lightweight markup language)」,讓純文字撰寫的文件,就已經具有良好的可讀性,可以透過 E-Mail 等方式發佈,也可以方便地透過多種工具,轉換成瀏覽效果更現代化的 (X)HTML,等於是一魚多吃。

對軟體開發者來說,每天撰寫大量文件可說是家常便飯,不論是撰寫系統設計規格文件,或是透過電子郵件及論壇的討論內容,以及自己的備忘文件。有時候這些文件寫得落落長,不僅要分章節,還參雜不少超連結、程式碼和註記。

到底要用純文字(Plain Text)撰寫?還是用網頁格式(HTML)寫?其實各有利弊。用純文字寫很簡單,但美觀比不上網頁;網頁的標記語言很複雜,本身已經破壞了文件的結構,而且當發佈的平台限制必須為純文字時,又會變得不堪入目。

Markdown 讓我們魚與熊掌可以兼得,正是所謂的摸蛤兼洗褲。

簡單的文件範例
This is an H1
=============
*   Bird
*   Magic
Refer: <http://example.com/>

如果您已經使用 Dokuwiki 當協作平台,還可以安裝 Markdown Plugin ,同時支援 Wiki 及 Markdown 兩種語法,寫文件更加方便!

相關連結:

沒有留言:

張貼留言

lyhcode by lyhcode
歡迎轉載,請務必註明出處!