markdown 常用語法
首先,一開始接觸到Markdown是在職訓期間,老師用的 HackMD所編寫的共筆,之後發現在Github專案上,readme也是需要透過Markdown語法來編寫,在網路上找了一些大大的教學,並參考Markdown 文件,邊學邊寫,於是想在這裡做個紀錄,也當作練習寫文章的開頭,以下會整理一些目前較常用到的語法:
標題
1 | 1. # h1 |
與HTML的標題類似,在井字號後面加上空格,再打上標題即可。
分隔線
1 | 1. --- |
連續3個”-“號,類似HTML 裡的<hr>,成果如下
縮排、引言
1 | 1. > |
“>”符號以下的文字可以達成縮排,可在引用別人的話時使用,如
失敗乃成功之母
程式碼
1 | 1. ``` |
以```(反引號)作為開頭,中間的內容會被視為程式碼,記得最後要再用```包住。
若不知道反引號怎麼打出來,可切換至英文輸入法,點擊”~”這顆按鍵就是了。
跳脫字元
1 | 1. \ |
有時候在編寫Markdown文件時,會需要使用到Markdown語法的特殊字元,但並不想要讓該字元的效果跑出來,例如需要用到&時,可能要使用”&”或者”&”,也可以使用\來顯示某些特殊字元。
可以參考w3school的這篇文章,或者ASCII 對照表。
超連結
1 | 1. [顯示的文字](連結的網址) |
按照上面的格式輸入,就可以達到超連結的效果了,如同在跳脫字元的說明裡,有w3school及ASCII的超連結。
插入圖片
1 |  |
與超連結相同的作用方式,只是要在前面多加”!”來做為區別。
表格
1 | |標題|說明| |
建立表格需透過”|”及”-“來完成,手動要key出來比較困難,所以推薦使用Table Generator
標題 | 說明 |
---|---|
標題1 | 內容 |
Tips :
我自己也會用另一個方式,開啟HackMD點表格,再將格式複製下來XD
無序清單
1 | 1. - |
- HTML
- CSS
- PHP
功能與HTML中的<ur> <ul>一樣,是沒有序列關係的清單。
有序清單
1 | 1. Abc |
- 9:00 開會
- 10:30 報告進度
- 13:20 與主管外出拜訪客戶
功能與HTML中的<or> <ol>一樣,是有序列關係的清單。
以上是我目前較常使用到的語法,整理成筆記,方便之後忘記可以查閱。
另外,我自己習慣使用VScode來當作 markdown的編譯器。開啟md檔後,VScode可以點選在側邊開啟預覽模式,這樣在編寫md檔的時候,就比較能知道自己打出來的內容,實際上看起來長什麼樣子,可以避免一些錯誤或麻煩。