什麼是 Markdown 以及如何使用它?

Markdown 是一種輕量級的標記語言,可讓您使用純文字編輯器建立格式化的文字。Markdown 最初由 John Gruber 於 2004 年建立,廣泛用於文件、部落格、筆記,甚至網站和應用程式中的內容格式化。

在本文中,我們將介紹什麼是 Markdown、它通常在哪些地方使用,以及如何應用其最重要的格式化功能。

什麼是 Markdown?

Markdown 是一種在網路上設定文字樣式的簡單方法。Markdown 允許使用者使用可讀的純文字語法編寫,然後將其轉換為 HTML,而無需使用複雜的 HTML 標籤或 WYSIWYG 編輯器。

例如,要使文字變粗體,您只需將其包在雙星號中,如 **這樣 **,要建立清單,您可以使用破折號或數字。

Markdown 因其簡潔性和靈活性的平衡而廣受歡迎,使得技術和非技術使用者都可以輕鬆上手。

Markdown 的常見用途

Markdown 用於許多需要設定樣式或結構化純文字的地方。

技術文件

開發人員和技術作家經常使用 Markdown 來編寫文件,因為它具有可讀性,並且易於與 Git 等版本控制系統整合。

GitHub 中的 README 檔案

GitHub 原生支援 Markdown 用於 README 檔案和文件。它是介紹和解釋專案的預設格式。

部落格和內容寫作

許多現代靜態網站產生器(如 Jekyll、Hugo 和 Next.js)支援使用 Markdown 進行內容建立。部落格平台(如 Ghost 和 Dev.to)也使用它。

筆記應用程式

Obsidian、Notion(部分支援)和 Bear 等應用程式允許使用者使用 Markdown 語法編寫筆記,以便輕鬆格式化。

電子郵件格式和訊息傳遞

某些電子郵件用戶端和訊息傳遞平台(如 Slack 和 Discord)允許使用部分 Markdown 語法進行基本格式化,如粗體、斜體或程式碼區塊。

基本 Markdown 語法以及如何使用它

Markdown 語法簡單明瞭且易於閱讀。以下是您需要的最常見元素。

標題

使用 # 符號建立標題。# 符號的數量對應於標題層級。

# H1 - 主標題
## H2 - 章節標題
### H3 - 小節標題

強調

您可以使用斜體或粗體來強調文字:

*斜體文字* 或 _斜體文字_
**粗體文字** 或 __粗體文字__
***粗體和斜體*** 或 ___粗體和斜體___

清單

Markdown 支援無序清單和有序清單。

  • 無序清單:

    - 項目 1
    - 項目 2
      - 子項目
    
  • 有序清單:

    1. 第一個項目
    2. 第二個項目
       1. 巢狀項目
    

連結

若要新增超連結,請使用方括號表示文字,並使用括號表示 URL:

[造訪 OpenAI](https://www.openai.com)

圖片

圖片使用與連結相同的語法,但以驚嘆號開頭:

![替代文字](https://example.com/image.png)

區塊引言

若要建立區塊引言,請在行首加上 >

> 這是一個區塊引言。

程式碼和程式碼區塊

對於行內程式碼,請使用反引號將文字包起來:

使用 `console.log()` 函數。

對於多行程式碼區塊,請使用三個反引號:

```javascript
function greet(name) {
  return `Hello, ${name}`;
}
```

水平線

使用三個或更多個破折號、星號或底線來建立水平線:

---

表格

Markdown 表格使用直線和連字符:

| 語法 | 描述 |
|--------|-------------|
| 標題 | 標題       |
| 儲存格 | 內容     |

Markdown 書寫技巧

  • 使用 Markdown 預覽工具(如 VS Code、Typora 或 StackEdit)即時檢視輸出。
  • 撰寫較長的文件時,使用適當的標題組織您的章節。
  • 使用一致的格式以保持清晰。
  • 使用註解(HTML 樣式 <!-- Comment -->)留下不會出現在最終輸出中的註解。