什麼是 Markdown ?

1
什麼是 Markdown ?:Markdown 是一種輕量級標記語言,使用純文字格式透過簡單符號撰寫結構化文件,能輕鬆轉換為 HTML、PDF 等格式,同時保持原始檔案高度可讀性。它由 John Gruber 於 2004 年開發,目標是「易讀易寫」,廣泛應用於 GitHub README、文檔撰寫、技術部落格與靜態網站生成,是現代開發者文件撰寫的標準工具。

什麼是 Markdown ?

Markdown 是一種輕量級標記語言,使用純文字格式透過簡單符號撰寫結構化文件,能輕鬆轉換為 HTML、PDF 等格式,同時保持原始檔案高度可讀性。它由 John Gruber 於 2004 年開發,目標是「易讀易寫」,廣泛應用於 GitHub README、文檔撰寫、技術部落格與靜態網站生成,是現代開發者文件撰寫的標準工具。

 

Markdown 的核心設計理念

Markdown 平衡了可讀性結構化

原始 Markdown(可直接閱讀):
# 專案介紹
這是一個 **開源專案**,支援多語言。

## 快速開始
```bash
npm install
npm start
 


**轉換後 HTML**:
```html
<h1>專案介紹</h1>
<p>這是一個 <strong>開源專案</strong>,支援多語言。</p>
<h2>快速開始</h2>
<pre><code>npm install
npm start</code></pre>
<a href="https://example.com">官方文件</a>
 

完整語法參考

標題(6 層級)

# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題

 

顯示效果:由大到小字體,自動編號目錄

文字格式

**粗體** 或 __粗體__
*斜體* 或 _斜體_
***粗斜體*** 或 ___粗斜體___
~~刪除線~~
<code>行內程式碼</code>
*傾斜且有強調*

 

列表

無序列表

- 項目一
- 項目二
  - 子項目
* 項目三
+ 項目四
 

有序列表

1. 第一步
2. 第二步
   1. 子步驟
3. 第三步
 

任務列表(GitHub 支援):

- [x] 已完成任務
- [ ] 未完成任務
- [x] 另一完成項目
 

連結與圖片

[顯示文字](https://example.com)
[顯示文字](https://example.com "提示文字")

![顯示文字](https://example.com/image.png)
![顯示文字](https://example.com/image.png "提示文字")

 

參考式連結(乾淨格式):

此為 [Google][google] 連結

[google]: https://google.com
 

程式碼區塊

行內程式碼:使用單反引號 code

程式碼區塊

```python
def hello_world():
    print("Hello, Markdown!")
    return "World"
```
 

語法高亮:指定語言 pythonjavascriptbashjson 等

表格

| 欄位1 | 欄位2 | 欄位3 |
|-------|-------|-------|
| 左對齊 | 居中 | 右對齊 |
| a     | b     | c     |

 

對齊控制

:--- 左對齊
:---: 居中
---: 右對齊
 

其他常用語法

> 這是引用區塊
>> 嵌套引用

---

水平分隔線

*斜體*
**粗體**
***粗斜體***

[TOC] 自動產生目錄(部分編輯器支援)

 footnotes[^1]

[^1]: 註腳說明
 

Markdown 編輯器與平台

類型 工具 特色
線上編輯器 StackEdit、HackMD、Dillinger 即時預覽、雲端同步
桌面應用 Typora、Mark Text、Obsidian 美觀介面、離線使用
IDE 插件 VS Code、JetBrains 整合開發環境
筆記應用 Notion、Typora、Obsidian 知識管理

推薦 VS Code 外掛

Markdown All in One
Markdown PDF
Markdownlint
 

Markdown 擴充語法(GFM)

GitHub Flavored Markdown 支援進階功能:

**任務列表**
- [x] 已完成
- [ ] 待辦

**表格**
| Name | Age |
|------|-----:|
| Alice| 25  |

**自動連結**:https://github.com

**刪除線**:~~已過時~~

**表情符號**::smile: :rocket:
 

Markdown 在開發工作流中的應用

1. GitHub README

# 專案名稱
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

## 功能特性
- ✅ 功能一
- ✅ 功能二

## 安裝
```bash
git clone https://github.com/user/repo.git
cd repo
npm install

 

貢獻指南

請參閱 CONTRIBUTING.md


### **2. API 文件**
```markdown
## GET /api/users/:id

### 參數
| 名稱 | 類型 | 說明 |
|------|------|------|
| id   | integer | 使用者 ID |

### 回應範例
```json
{
  "id": 1,
  "name": "Alice",
  "email": "[email protected]"
}
 


### **3. 技術筆記**
````markdown
# Python 快速入門筆記

## 列表推導式
```python
# 傳統迴圈
squares = []
for i in range(10):
    squares.append(i**2)

# 列表推導式
squares = [i**2 for i in range(10)]
 

常見錯誤

#  IndexError
lst =[11][12][13]
print(lst)  # Index out of range[13]
 


## Markdown 轉換工具

**命令列工具**:
```bash
# 安裝
npm install -g markdownlint-cli

# 轉 HTML
pandoc input.md -o output.html

# 轉 PDF
pandoc input.md -o output.pdf --pdf-engine=xelatex
```

**JavaScript 庫**:
```javascript
import marked from 'marked';
const html = marked.parse('# Hello Markdown');
```

## 最佳實務與注意事項

** 寫作習慣**:
```
使用適當標題層級(H1 僅用於主標題)
段落間空行分隔
程式碼區塊指定語言
表格使用簡單結構
連結檢查有效性
```

** 常見錯誤**:
```
多餘空格:`**粗體**` → `**粗體**`
列表縮排錯誤:
 - 子項目(無縮排)
   - 子項目(2-4 空格)
程式碼區塊無語言:``` → ```python
```

**效能技巧**:
```
大文件分拆:README.md → docs/
使用 Frontmatter 元資料:
---
title: 專案介紹
date: 2026-01-25
tags: [markdown, 文件]
---
```

Markdown 已成為開發者溝通的通用語言,從 README 到技術文件,從個人筆記到企業 Wiki。它的簡單性讓你專注內容而非格式,轉換能力讓文件多平台流通,跨編輯器支援確保未來相容性。掌握 Markdown = 提升專業形象與溝通效率!