# Markdown `了解如何使用markdown撰寫文件` ###### tags: `RD1` :::spoiler 目錄 [TOC] ::: #### GitHub 有使用過 GitHub 都一定有看過 README.md,而 md 表示的意思其實就是 Markdown ,所以如果在開發時會使用 README.md 的人,就一起來看看在 README.md 上如何用 Markdown 撰寫吧! ## 列表 #### 寫法 \- 這是清單 \+ 這也是清單 \* 這同樣是清單 \- 清單子項目 #### 顯示畫面 - 這是清單 + 這也是清單 * 這同樣是清單 - 清單子項目 包含數字符號的列表則是使用 數字 + .作為開頭,列表中的第一個數字是數字列表的起始序號,而後方的數字不需要按照順序,如:1. 2. 2. 結果依然會是 1. 2. 3.;另外縮排的規則與一般列表相同 #### 寫法 1. 數字型清單 2. 第二個數字清單 2. 數字清單不需要連續數字 1. 數字清單子項目 3. 數字清單子項目 4. 數字清單子項目 #### 顯示畫面 1. 數字型清單 2. 第二個數字清單 2. 數字清單不需要連續數字 1. 數字清單子項目 3. 數字清單子項目 4. 數字清單子項目 ## CheckBox #### 寫法 \- [ ] 待辦事項 \- [x] 完成事項 #### 顯示畫面 - [ ] 待辦事項 - [x] 完成事項 ## 表格 #### 寫法 \| thead 1 | thrad 2 | thread 3 | \|---------|---------|----------| \| td | td | td | #### 顯示畫面 | thead 1 | thrad 2 | thread 3 | |---------|---------|----------| | td | td | td | ## 區塊 #### 寫法 小區塊語法(前後加上\`): \`Format one word or one line\` 高亮程式碼顯示語法 (前後三個反引號 \`\`\` + 語言) \`\`\`sql INSERT INTO 表 VALUES (值,值) \`\`\` #### 顯示畫面 小區塊語法(前後加上\`): `Format one word or one line` 大區塊語法(四個空白): code (4 spaces indent) 高亮程式碼顯示語法 (前後三個反引號 \`\`\` + 語言) ```sql INSERT INTO 表 VALUES (值,值) ``` ## 圖片 #### 寫法 \![名稱]\( 圖片網址 "title") 一個驚嘆號! 接著一個方括號,裡面放上圖片的替代文字 接著一個普通括號,裡面放上圖片的網址,最後還可以用引號包住並加上 選擇性的’title’文字。 ex: \![窩不知道]\(https://truth.bahamut.com.tw/s01/201911/4e3eb1c83a9c6204fd1cdcff2206e831.JPG?w=1000) #### 顯示畫面 ![窩不知道](https://truth.bahamut.com.tw/s01/201911/4e3eb1c83a9c6204fd1cdcff2206e831.JPG?w=1000) ## 連結 #### 寫法 \[名稱]\(連結) ex: \[Markdown文件](https://markdown.tw/) #### 顯示畫面 [Markdown文件](https://markdown.tw/) ## 階層式區塊 階層式區塊在表現結構或功能關係上是相當好用的呈現形式 #### 階層式區塊語法: \> Quote one sentences \>>Quote two sentences \>>Quote two sentences \>>>Quote three sentences #### 顯示結果: > Quote one sentences >>Quote two sentences >>Quote two sentences >>>Quote three sentences ## 粗體 #### 寫法 \*\*bold** \_\_bold__ #### 顯示結果: **bold** __bold__ ## 斜體 #### 寫法 \*bold* \_bold_ #### 顯示結果: *bold* _bold_ ## 刪除線 #### 寫法 \~\~我是刪除線~~ #### 顯示結果: ~~我是刪除線~~ ## 分隔線 #### 寫法 分隔線,可以使用三個連續符號表示(-、*,部分環境亦可使用 _) \--- (三個減號) \*** (三個星號) \___ (三個底線) #### 顯示結果: --- *** ___ ## 跳脫字元 Markdown可以利用反斜線來插入一些在語法中有其他意義的符號,例如:如果你想要用星號加在文字旁邊的方式來做出強調效果(但不用標籤),你可以在星號的前面加上反斜線: Markdown支援在下面這些符號前面加上反斜線來幫助插入普通的符號: ``` \ 反斜線 ` 反引號 _ 底線 {} 大括號 [] 方括號 () 括號 # 井字號 + 加號 - 減號 . 英文句點 ! 驚嘆號 * 星號 ``` # 標題 \# 標題1 ## 標題2 \## 標題2 ### 標題3 \### 標題3 #### 標題4 \#### 標題4 ##### 標題5 \##### 標題5 ###### 標題6 \###### 標題6 參考資料 [Markdown文件](https://markdown.tw/) [Markdown - 易編易讀,優雅的寫文吧!](https://ithelp.ithome.com.tw/articles/10203758) [十分鐘快速掌握 Markdown](https://wcc723.github.io/development/2019/11/23/ten-mins-learn-markdown/)