Smalljie的前端探索

網頁開發與前端技術的探索之旅

0%

Markdown 基礎與入門教學

前言

該文章會集中介紹 Markdown 常見標籤,同時也是記錄自己學習 Markdown 標籤的紀錄

標題

標題的標籤是採用井字號作為開頭

1
2
3
4
5
6
# This is an H1
## This is an H2
### This is an H3
#### This is an H4
##### This is an H5
###### This is an H6

此標籤會生成<h1>~</h6>的標籤

粗體

文字粗體只需要使用兩個米字號並包覆該文字即可達到。

1
我是 **smalljie** 我是粗體

我是 smalljie 我是粗體

該標籤會生成<strong>標籤

斜體

要將文字斜體只需要一個*前後包覆

1
Hello *World*

Hello World

刪除線

文字刪除線是使用前後兩個波浪符來達到該需求

1
今天~~來解JS的BUG~~

範例: 今天來解 JS 的 BUG

此標籤會生成<s>標籤

分隔線

分隔線有分為兩種

1
2
1. ***
2. ---

一般來說最常使用的是使用減號取代星號,最主要是閱讀上問題。

範例:



分隔線會生成<hr>標籤

插入連結

連結插入方式有兩種

常見插入方式

1
[連結名稱](超連結)

範例: Google

快速連結

1
<https://www.google.com/>

範例: https://www.google.com/

以上兩種方式皆會產生 <a> 連結標籤。

項目清單

項目清單分為兩大類

  1. 無序清單
  2. 有序清單
1
2
3
4
1. *
2. +
3. -
4. 1. ...2.

無序清單

以下是無序清單的範例

減號

  • 這是減號的效果
  • 測試這是減號的效果

星號

  • 這是星號的效果
  • 測試這是星號的效果

加號

  • 這是加號的效果
  • 測試這是加號的效果

以上三種會產生 <ul> > <li> 標籤。

有序清單

數字清單

  1. 測試
  2. 這是測試的一句話

數字清單會產生 <ol> > <li> 標籤。

引用標籤

此標籤在使用時需多加注意,其主要原因是該標籤會生成 blockquote,在 SEO 代表著引用的意思。

1
> 引用一句話

範例:

引用一句話

圖片

圖片的操作方式與連結雷同,但只需要前面加入一個驚嘆號就可以使用了。

1
![圖片名稱](圖片連結)

此語法會產生<img>標籤

勾選

勾選欄位,勾選欄位最常出現於代辦事項。

1
2
- [ ] 今天睡覺
- [x] 今天還沒睡覺

範例:

  • 寫文章
  • 不寫文章

該格式會產生 <ul> > <li> 且會透過 JavaScript 監聽操作,該標籤不一定適用於每個網站。

程式碼片段

1
`let a = 10;。`

let a = 10;。

用來顯示程式碼的片段

程式碼區塊

程式碼區塊使用的則是上下三個反引號包覆。

1
2
let a = 10;
a++;

程式碼相關標籤都會產生 <pre> > <code> 標籤

表格

arkdown 也有支援表格撰寫,不過在此建議使用第三方生成工具,因為 Markdown 表格較難撰寫。

1
2
3
|   標題1  | 標題2 |
|:-----------:|:----------:|
| 好 | 不好 |
標題 1 標題 2
不好

表格將會生成 table 標籤。

MD 表格第三方產生器

  1. Markdown Tables generator
  2. tableconvert

注意事項

以下為常見撰寫 Markdown 的問題

  • 標題與段落之間沒使用一個 Enter 斷行。
  • 程式碼片段沒使用一個 Enter 斷行。
  • 程式碼片段沒有寫入高亮語言。
  • 標體寫入了標點符號,在規範中標題是不宜寫入標點符號。
  • 段落與段落之間採用一個 Enter 取代兩個空白鍵。
  • 文章結尾缺少一個 Enter。
  • 大多文章標題就是 <h1>(ex: Hexo),所以會建議從 <h2> 開始使用撰寫

參考文章

Markdown 基礎與入門教學手冊

Markdown 和 HTML 基礎語法教學

Markdown