有使用過 GitHub 可能會看過 README.md 或者其他 xxx.md 的檔案,md 表示的意思其實是 Markdown,所以如果有在開發 open source project 的人可能會需要知道 Markdown 文件如何撰寫。

基本上 Markdown 可以用比較簡單的方式撰寫,自動產生出一些網頁語法。而 Markdown 除了最原始版本的定義之外,後來也有一些擴充功能,例如 Table 和 Syntax Highlighting 等。

這邊整合了一份在 GitHub 可用的 Markdown 語法說明與範例:Markdown 範例

在上面的網址裡直接在 GitHub 建立 Repository 撰寫 README.md,可以實際看到語法產生的結果。

參考資料