Markdown:寫一次,到處發布

你需要寫文件。或 README。或部落格文章。或帶有格式的 Slack 訊息。

HTML 太複雜。Word 文件不是到處都有效。純文字沒有格式。

Markdown 處於最佳位置。簡單的語法,作為純文字可讀,需要時轉換為 HTML。

基礎

# 標題 1
## 標題 2
### 標題 3

**粗體** 和 *斜體*

- 項目符號點
- 另一個點
  - 巢狀點

1. 編號清單
2. 第二項

[連結文字](https://example.com)

![圖片替代文字](image.jpg)

這就是你需要的大部分。

程式碼格式

用反引號的內聯程式碼:console.log('hello')

用三個反引號的程式碼區塊:

function hello() {
  return 'world';
}

在開頭反引號後指定語言以進行語法高亮。

表格

| 名字  | 角色       |
|-------|------------|
| Alice | 開發者  |
| Bob   | 設計師   |

表格輸入起來很繁瑣。大多數編輯器都有快捷鍵。

區塊引用

> 這是一個引用。
> 它可以跨越多行。

用於標註、引用或強調重要文字。

為什麼 Markdown 有效

可讀的原始碼。 即使沒有渲染,Markdown 也很容易閱讀。**粗體** 顯然是粗體。

可攜帶。 GitHub、Notion、Slack、Reddit、無數靜態網站生成器。寫一次,到處貼。

版本控制友好。 它是純文字。Git diff 有意義。合併有效。

面向未來。 沒有專有格式。你的內容永遠可訪問。

風格差異

GitHub Flavored Markdown (GFM) 添加核取方塊、表格和語法高亮。

CommonMark 是標準化工作。大多數平台支援它。

有些平台添加額外功能:Obsidian 有 wikilink,Notion 有資料庫。

為了最大的可攜帶性,堅持基本語法。

常見錯誤

忘記空行。 段落之間需要空行。沒有它們,所有東西都跑在一起。

標題後的空格。 #標題 不起作用。# 標題 起作用。注意空格。

損壞的連結。 缺少 https:// 會使連結在某些平台上失敗。

沒有替代文字的圖片。 ![](image.jpg) 有效但不可訪問。添加描述。

寫作技巧

使用標題來建立結構。讀者在閱讀前先掃描。

保持段落簡短。空白有助於可讀性。

發布前預覽。不同的渲染器處理邊緣情況的方式不同。

---

Markdown 消除了寫作的摩擦。學一次基礎,到處使用。簡單性就是功能。