2021年2月19日 星期五

Markdown 筆記

作者:王一哲
日期:2021/2/19


前言


Markdown 是一種輕量的標記語言,使用鍵盤上就有的標記做出具有數學式、清單、表格……等等的文件。我通常會使用 HackMD 線上編輯 Markdown 文件,單機版的部分則是使用 JoplinTypora 或是普通的純文字檔編輯器。網路上已經有許多 Markdown 語法的教學,以下是我常用的語法及筆記。
註:由於我沒有將部落格修改成支援 Markdown 語法,以下的內容只保留語法的部分,如果想要看到 Markdown 語法呈現的效果,請參考這篇文章的 HackMD 版本


標題


標題共有6個層級,標題開頭以 # 標示,有幾個 # 就是第幾個層級的標題,通常一篇 Markdown 文件只會有一個第1層級的標題,語法如下。
# 層級1
## 層級2
### 層級3
#### 層級4
##### 層級5
###### 層級6
###### tags:`標籤`



文字格式


Markdown 有以下的文字格式,如果使用的編輯軟體不支援上標、下標語法,可以改用 HTML 的語法。
*斜體*
**強調、粗體**
~~刪除線~~
^上標^ 或 <sup>上標</sup>
~下標~ 或 <sub>下標</sub>



數學式


Markdown 支援 $\LaTeX$ 語法,只要用 \$ 將 $\LaTeX$ 數學式區塊包起來即可,又分為獨立成段的單行數學式及行內數學式兩種格式。
$$
單行數學式 y = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$

行內數學式 $y = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$

$$ 單行數學式 y = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$ 行內數學式 $y = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$


程式碼


程式碼區塊以 ``` 標示,開頭的 ``` 後面可以加上程式碼的種類,例如c、python……等等,如果再加上 =,有些編輯器會自動為程式碼加上行號。以最簡單的 Hello World! 為例:
#include <stdio.h>

int main(void) {
	printf("Hello World!\n");
	return 0;
}



清單


清單分為無編號、有編號、待辦清單,語法如下。
- 項目1
- 項目2
- 項目3

1. 項目1
2. 項目2
3. 項目3

- [ ] 項目1(未完成)
- [ ] 項目2(未完成)
- [X] 項目3(已完成)



表格


表格的語法如下,空格及 - 的數量並不重要。
|   | column 1 | column 2 | column 3 |
|-|--|---|----|
| row 1 | a11 | a12 | a13 |
| row 2 | a21 | a22 | a23 |



超連結及圖片


超連結的語法為
[文字](網址)
以 Google 首頁 為例
[Google 首頁](https://www.google.com.tw/)

圖片的語法為
![](網址或路徑 "說明文字(可不加)")
以我自己上傳到 Imgur 的照片為例,將滑鼠游標移到圖片上停住,游標處會顯示 D1 mini。
![](https://i.imgur.com/zf8SAST.jpg "D1 mini")

如果要做出用滑鼠左鍵點擊圖片、開啟 YouTube 影片的效果,可以使用以下的語法
[![](圖片連結)](影片連結)
以 DeltaMOOCx 高中物理的影片為例
[![](https://i.imgur.com/iPGnuzh.png)](https://youtu.be/Q59BINcFHOc)



引用區塊


引用區塊是以 > 開頭,可以每一行都加上 >,或是只有第一行都加上 >,接下來在遇到空行之前的文字都在引用區塊的範圍內。如果引用區塊有很多層級,只要在該行開頭加上對應數量的 > 即可。
> 引用區塊第1行
引用區塊第2行
引用區塊第3行
> 引用區塊第1層
>> 引用區塊第2層
>>> 引用區塊第3層



縮排


使用 tab 鍵縮排,可以有不同層級的縮排。
[tab]層級1
[tab][tab]層級2
[tab][tab][tab]層級3



分隔線


分隔線有以下幾種語法,看起來效果都一樣。
---
***
- - -
* * *



結語


以上是我常用的 Markdown 語法,網路上還有更多詳細的教學文章,有興趣的同學可以上網搜尋或是點擊下方的參考資料。


參考資料


  1. Markdown文件
  2. MarkDown+HackMD新手教學




HackMD 版本連結:https://hackmd.io/@yizhewang/r1nHgohWu

沒有留言:

張貼留言