Markdown 語法教學

前言

因為沒有撰寫Markdown的經驗,這次將初步習得的一些基本語法寫下來,免得以後失憶又要各種翻翻找找,順便提供給跟我一樣是新手的人參考囉!

What is Markdown?

是一種輕量級標記語言,創始人為 John Gruber。
Markdown編寫的純文本檔案可轉換成有效的XHTMLHTML文件,使開發者能更專注於內容寫作,易讀易寫是其最大特色。

語法範例

➤ 標題

setext 形式:

H1

H2

<!-- 下方為 Markdown 寫法 -->
H1
==
H2
--

Christine’s Memo:

=-在撰寫時沒有限制要輸入多少數量,基本上符號的上面一行都會套用H1的效果,也因此要特別注意,若有不想套用到效果的文字要記得分開寫。setext僅支援H1H2兩種標題。

atx 形式:

H1

H2

H3

H4

H5
H6
<!-- 下方為 Markdown 寫法 -->
# H1  
## H2  
### H3  
#### H4  
##### H5  
###### H6

Christine’s Memo:

#可以只寫在左邊,也可以左右對稱包住標題文字,例如# H1 #,特別注意#後面要空一格再加上標題文字,不然會被視為純符號。


➤ 內文

粗體
粗體
斜體
斜體
刪除線

<!-- 下方為 Markdown 寫法 -->
__粗體__  
**粗體**    
_斜體_   
*斜體*   
~~刪除線~~ 

➤ 連結

Christine’s Site
https://christine590.github.io/

<!-- 下方為 Markdown 寫法 -->
[Christine's Site](https://christine590.github.io/ "Christine's Site")
<https://christine590.github.io/> 

Christine’s Memo:

連結寫法不只一種,上面以最常見的方法為例,用法為[連結識別名稱](連結路徑) "連結title屬性的值" ,而使用<連結路徑>則會自動將包住的Url轉為超連結。上方所指的連結路徑可為網址或專案中檔案的相對路徑。


➤ 清單

無排序:

  • 台劇
  • 日劇
  • 韓劇
    • 告白夫婦
    • 孤單又燦爛的神-鬼怪
    • 愛的迫降
<!-- 下方為 Markdown 寫法 -->
* 台劇
+ 日劇
- 韓劇
  * 告白夫婦
  + 孤單又燦爛的神-鬼怪
  - 愛的迫降

有排序:

  1. 台劇
  2. 日劇
  3. 韓劇
<!-- 下方為 Markdown 寫法 -->
1. 台劇
4. 日劇
6. 韓劇

Christine’s Memo:

*+-都能做為清單項目的標記符號,並可直接以空格縮排表示階層。而直接輸入數字+.+空格即可表示有序清單,其中數字正確性不重要,顯示於頁面都會是正確排序。

Check box:

  • 有打勾的項目
  • 未打勾的項目
<!-- 下方為 Markdown 寫法 -->
- [X] 有打勾的項目  
- [ ] 未打勾的項目

➤ 區塊

小區塊:
這是標籤內的文字,可隨時在行內穿插。

<!-- 下方為 Markdown 寫法 -->
這是`標籤內的文字`,可隨時在行內穿插。

大區塊:
顯示的畫面第一行(左邊輸入四個空格)

顯示的畫面第三行
顯示的畫面第四行
......
<!-- 下方為 Markdown 寫法 -->
    Markdown文件中第一行(左邊輸入四個空格)

    Markdown文件中第三行
    Markdown文件中第四行
    ......

階層區塊:

第一層

第二層

第三層

<!-- 下方為 Markdown 寫法 -->
>第一層
>>第二層
>>>第三層

程式碼高亮區塊:

//如果是JavaScript
window.addEventListener('load', function() {  
  console.log('window loaded');  
});  
<!-- 下方為 Markdown 寫法 -->
ˋˋˋJavaScript
This is your code 
ˋˋˋ

Christine’s Memo:

前後使用三個反引號包住即可用來表示程式碼區塊,若想要高亮效果,可於第一行寫下程式語言的名字,特別注意所用的反引號為Tab上面、數字1左邊的按鍵,而非數字4的按鍵。


➤ 圖片

圖片Alt屬性的值

<!-- 下方為 Markdown 寫法 -->
![圖片Alt屬性的值](/images/demo.jpg)

Christine’s Memo:

圖片寫法不只一種,上面以最常見的方法為例,用法為[圖片Alt屬性的值](連結路徑)。連結路徑一樣可為網址或專案中檔案的相對路徑,特別注意Markdown無法直接指定圖片大小。


➤ 表格

1 2 3
4 5 6
7 8 9
<!-- 下方為 Markdown 寫法 -->
1           | 2            | 3  
:-----------|:------------:|-----------:
 4          | 5            | 6 
 _7_        | `8`          | **9** 

Christine’s Memo:

:可用來表示欄位的對齊方式,每個標頭元件都需用|隔開,但最外圍的豎線可省略。撰寫時不需特別使原始文字排列整齊,表格內也可使用文字樣式的Markdown語法。


➤ 其他

水平裝飾線:




<!-- 下方為 Markdown 寫法 -->
---
***
___ 

Christine’s Memo:

*-_皆可為裝飾線使用符號,但符號必須為獨立一行,不能跟其他文字混寫。

一般化符號:
可在下列符號前加上反斜線來表示只想插入普通符號,使其不具特殊功能。
\
-
+
*
`
_
{
[
(
#
.
!

<!-- 下方為 Markdown 寫法 -->
\\  
\-  
\+  
\*  
\`  
\_  
\{  
\[  
\(  
\#  
\.  
\! 

註解:
Markdown的註解跟HTML相同,使用<!--加上-->包住註解文字。

<!-- 可將註解寫在這裡 -->

換行:
欲換行的時候可在該行最後按兩個空白,或直接在檔案中按下Enter空出幾行。

後記

推薦新手可參考下面兩個網站,第一個是英文網站,可以帶你迅速理解Markdown的概念並練習基本語法;第二個是中文網站,提供多種Mardown語法範例,很適合入門者無腦複製貼上。

  1. https://commonmark.org/
  2. http://xianbai.me/learn-md/index.html