GitHub 中 README.rd 的 markdown 語法

今天在編輯 GitHub 上的 README.rd 檔時發現它使用所謂的 markdown 語法, 再轉成 HTML 網頁, 編輯器中的單純跳行沒有效果, 全部內容會黏在一起, 看來有必要對 markdown 語法做個簡單的了解, 參考下面這篇文章 :

# https://github.com/othree/markdown-syntax-zhtw#p

Git 學習筆記參考 :

# Git 學習筆記索引


我常會用到的語法只有如下幾個 :

1. 跳行 :

在 markdown 中要跳行是在行尾輸入兩個 space 再按 enter, 這樣會產生一個空行, 不是換行而已.

另外若要產生標題效果則用 1~6 個井號 #, 分別會被轉成 h1~h6 的 HTML 標籤, 例如 :

# This is H1
## This is H2
### This is H3
#### This is H4
##### This is H5
###### This is H6

2. 清單 :

無序清單用星號 *, 加號 +, 或減號 - 都可以, 它們會被轉成 HTML 的 ul-li, 例如 :

* APPLE
* Google
* Amazon

有序清單則直接用數字後面加小數點, 例如 :

1. APPLE
2. Google
3. Amazon


3. 分隔線 :

用三個以上連續的星號 *, 減號 -, 或底線 _ 都可以建立分隔線, 例如 :

***
---
___


4. 超連結 :

超連結文字放在中括號裡面, 後面緊跟著放在小括號裡面的 url, 格式如下 :

[連結文字](URL)

例如 :

[praat-project](https://github.com/tony1966/praat-project)

如果連結文字就是網址的話可直接用角括號將 URL 包起來, 例如 :

<https://github.com/tony1966/praat-project>


5. 斜體 (強調) :

用星號 * 或底線 _ 包圍起來的文字會被轉成 em 標籤而變斜體, 例如 :

*這段文字變斜體*
_這段文字變斜體_


6. 圖片 : 

語法與超連結類似, 但前面用驚嘆號 ! 開頭, 中括號內放的是萬一圖片不存在時的替代顯示文字, 格式如下 :


例如 :



7. 跳脫字元 :

如果要用到上面的控制字元本身, 例如星號, 減號, 底線, 或驚嘆號等, 可以在這些控制字元前面加上倒斜線來跳脫其特殊性, 例如 :

\***
\!
\[this is bracketed words\]

這樣編寫 README.rd 檔就方便多了.

2022-07-29 補充 : 

關於 markdown 語法, 參考 :

# https://markdown.tw/