Markdown使用心得記錄

Markdown哲學

  • 易讀易寫：Markdown的語法全由 [標點符號] 所組成。
  • 可讀性強：可以直接以 [純文字] 發佈，並且看起來不會像是由許多標籤或是格式指令所構成。

Markdown基本語法

§ 標題(Title)

將 # 符號置於標題前面便能將文字顯示為標題大小，#的數量決定標題大小，#號後面有空一格。

語法：

# 這是H1標題
## 這是H2標題
### 這是H3標題
#### 這是H4標題
##### 這是H5標題
###### 這是H6標題

結果：

這是H1標題

這是H2標題

這是H3標題

這是H4標題

這是H5標題
這是H6標題

§ 引用文字(Block)

利用 > 符號顯示引用文字，> 號後面有空一格。

語法：

> 靜思語：生氣是拿別人做錯的事來懲罰自己

結果：

靜思語：生氣是拿別人做錯的事來懲罰自己

§ 文字格式(Styling text)

  • 在文字前後加*，便顯示斜體
  • 在文字前後加**，便顯示粗體
  • ~~ ~~中間的文字會加上刪除線

語法：

**粗體**
*斜體*
~~我寫錯了~~

結果：

粗體 斜體 我寫錯了

§ 列點(List)

無序列點：可以用「*」或「-」或「+」列點，記得後面的文字之間要空一格。

語法：

* Java
* Python
- Boy
- Girl
+ Sun
+ Moon

結果：

  • Java
  • Python
  • Boy
  • Girl
  • Sun
  • Moon

有序列表：直接以1、2、3、4…列點。列點與後面的文字之間也要空一格。

語法：

1. 前言
2. 目標
3. 結論

結果：

  1. 前言
  2. 目標
  3. 結論

巢狀列表：需縮排的列表，使用半型空白空3格。

語法：

1. 目標
   1. 發表文章
   2. 申請專利
   3. 貢獻
2. 研究著作
   * Conference
   * SCI/EI
3. 結論

結果：

  1. 目標
    1. 發表文章
    2. 申請專利
    3. 貢獻
  2. 研究著作
    • Conference
    • SCI/EI
  3. 結論

§ 程式碼格式(Code formatting)

在文字區塊的上下方輸入3個反引號「```」， 或用4個空格就可以mark出程式碼區塊。

語法：(前面不用空隔)

    ```python
    import numpy as np
    time = np.arange(0, 10, 0.1)
    amplitude = np.sin(time)
    ```

結果：(沒標記語法格式)

import numpy as np
time = np.arange(0, 10, 0.1)
amplitude = np.sin(time)

結果：(標記語法格式python)

import numpy as np
time = np.arange(0, 10, 0.1)
amplitude = np.sin(time)

語法格式keyword: shell, cpp, python, ruby, javascript, SQL, …

§ 連結(URL)

[連結文字](連結位置)

語法：

[Google](https://www.google.com)

結果： Google

§ 表格(Table)

利用分割符號”-“和”|”建立表格。:可用來決定文字對齊方式(置中/靠左/靠右)

語法：

| 姓名   | 住址 | 學號 |
| :---- | :--: | ---: |
| 阿華田 | 台北 | 25   |
| 李大明 | 台中 | 28   |

結果：

姓名 住址 學號
阿華田 台北 25
李大明 台中 28

參考資料