Markdown 學習筆記:從「這啥挖溝?」到每天都在用

Why Markdown?

說真的,一開始是被逼的。

在寫 GitHub README 的時候,看到別人的專案頁面排版超漂亮,有標題、有表格、有程式碼區塊,我的卻是一坨純文字。

然後去查了一下,才知道那個叫 Markdown。

心想:「這東西看起來很簡單嘛,應該半小時就學完了吧?」

嗯⋯⋯大致上是對的,但要用得順手還是花了一點時間。


What is Markdown?

簡單說就是:用純文字寫出有格式的文件

你不需要點選單、不需要工具列,直接在文字裡加幾個符號,就能表示「這是標題」「這是粗體」「這是程式碼」。

最後再用支援 Markdown 的工具渲染出來,就會變成漂亮的排版。

GitHub、Notion、Obsidian、HackMD、各種部落格平台⋯⋯幾乎都支援。


我的學習過程

第一階段:看語法表,硬背

一開始就是找了一張 Markdown Cheat Sheet,然後對著它練習。

老實說這個方法沒什麼問題,因為語法真的不多,核心的大概就這些:

標題

# H1 標題
## H2 標題
### H3 標題

粗體 / 斜體

**粗體**
*斜體*
~~刪除線~~

清單

- 項目一
- 項目二
  - 縮排子項目

1. 有序清單
2. 第二項

連結 / 圖片

[顯示文字](https://example.com)
![圖片說明](圖片網址)

程式碼

行內程式碼用 反引號 包起來

程式碼區塊用三個反引號:
```c
int main() {
    return 0;
}</code></pre>
<pre><code>
**引用**
```markdown
> 這是引用文字

分隔線

---

表格

| 欄位一 | 欄位二 | 欄位三 |
|--------|--------|--------|
| A      | B      | C      |

第二階段:踩了幾個坑

學語法很快,但真正用的時候還是踩了不少雷。

空行的問題

這個坑我踩了好幾次。

Markdown 裡,換行不是你按一個 Enter 就換行,你需要空一整行,段落才會分開。

這是第一段
這行其實會跟上面黏在一起

這樣才是真的新段落

一開始寫出來的東西全部擠在一起,搞了很久才發現是這個問題。

縮排的問題

清單的縮排要用 2 個或 4 個空格,不同的渲染器行為不太一樣,有時候縮排沒有生效,看起來很怪。

後來我習慣統一用 2 個空格,大部分平台都能正常顯示。

程式碼區塊的語言標注

這個不是坑,但很多人不知道可以這樣做:

```c
// 這樣會有 C 語言的語法高亮
# 這樣是 Python
# 這樣是 Shell


加上語言標注之後,程式碼會有顏色,閱讀體驗差很多。

---

### 第三階段:找到順手的工具

光會語法還不夠,要有個好用的編輯器才會想一直用。

我試過幾個:

| 工具 | 特色 | 我的感想 |
|------|------|----------|
| **VS Code** | 輕量、有預覽、可裝外掛 | 寫技術文件首選 |
| **Obsidian** | 雙向連結、本地儲存 | 寫筆記很好用,有點學習曲線 |
| **HackMD** | 線上、可協作 | 跟別人一起寫文件超方便 |
| **Typora** | 所見即所得 | 介面最漂亮,但要付費 |

我現在主要用 **VS Code** 寫技術文章,**Obsidian** 管理個人筆記。

VS Code 裝一個 Markdown Preview Enhanced 外掛,右邊就能即時預覽,很夠用了。

---

### 第四階段:開始真的每天在用

現在 Markdown 對我來說已經是肌肉記憶了。

寫 README、寫技術文件、寫部落格、記工作筆記,全部都用 Markdown。

甚至在 Slack 或 GitHub Issue 留言,也會下意識地用 Markdown 語法,然後發現那個平台不支援,貼出去一堆奇怪符號 😅

---

## 幾個讓文章更好讀的小技巧

這些是我後來才慢慢養成的習慣:

- **段落不要太長**,3-5 行就換一個段落,手機看起來比較不累
- **善用粗體**標注關鍵字,讓讀者掃描文章時能快速抓到重點
- **程式碼一定要放進程式碼區塊**,不要直接貼在文字裡
- **表格適合比較型的資訊**,但欄位太多的話手機會跑版
- **標題層級不要亂用**,H1 通常只放一個(文章標題),內文從 H2 開始

---

## 小結

Markdown 真的是投資報酬率很高的技能。

學習成本低,大概一個下午就能上手基本語法,但用到的地方超多。

對工程師來說,寫 README、寫技術文件、在 GitHub 上溝通,幾乎都會用到。

如果你還沒學,建議你快去學,也歡迎留言分享心得。
分類: 技術相關,標籤: , , , , , , 。這篇內容的永久連結

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *