繁體中文
English 简体中文 繁體中文
Methodox 首頁

在這裡試一試!

1. 簡介

1.1 Markdown 為什麼這麼棒 ✨

Markdown 是擁有超能力的純文字。它讓你可以隨手記筆記、編寫文件、撰寫部落格文章,甚至排版 PDF——這一切都無需離開你最喜歡的文字編輯器。

  • 對人友好——原始形式就很易讀,因此將來的你(以及協作者)可以在任何終端中快速瀏覽。
  • 可移植——可用於 GitHub、GitLab、Stack Overflow、Jira、Notion,以及無數 CMS 和靜態網站生成器。
  • 快速——沒有按鈕,也沒有所見即所得(WYSIWYG)的種種謎團;直接輸入即可。
  • 版本控制的福音——因為是純文字,差異對比(diff)始終清晰乾淨。

1.2 你會在哪裡遇到 Markdown

  • GitHub 上的 README 檔案、issue 和 PR 範本。
  • 技術部落格(Jekyll、Hugo、Astro 等)。
  • 文件網站(Docsify、MkDocs、Docusaurus)。
  • 筆記應用(Obsidian、Logseq、Typora)。
  • 聊天和社羣工具(Telegram、Discord、Slack、Discourse)。

1.3 你可以實現的小奇蹟 😍

Markdown 的魔力在於,這些技巧中的每一個在原始文字中依然清晰可讀。

奇蹟 小片段 效果
任務列表 - [x] done
- [ ] to-do
在 GitHub issue 中顯示為可互動的核取方塊。
語法高亮 ```python
print("Hi")
```
像 IDE 一樣著色!
表格 | foo | bar |
|----|----|
整齊對齊的網格。
可摺疊塊 <details><summary>peek</summary>spoiler!</details> 按一下即可揭開祕密。
Emoji I ❤️ Markdown :tada: 變成 😍 🎉。

2 · 快速參考(速查表)

提示: 在 GitHub 上的 .md 檔案中試試每個示例,然後按一下 Preview(預覽)。

2.1 標題

# H1
## H2
### H3

渲染結果 ⇒

展開檢視

H1

H2

H3

2.2 強調

*italic*   _italic_
**bold**   __bold__
~~strike~~

italic bold strike

2.3 列表

無序列表

- Item A
  - Sub-item
* Asterisks work too
  • Item A

    • Sub-item
  • Asterisks work too

有序列表

1. First
2. Second
  1. First
  2. Second
[visible text](https://example.com)
<https://example.com>   <!-- autolink -->

visible text https://example.com

2.5 圖片

![Alt text](https://picsum.photos/200/300)

Alt text

2.6 程式碼

行內程式碼

`code` → code

圍欄程式碼塊(帶高亮)


```js
function greet() {
  console.log("Hello!");
}
```

2.7 引用塊

> One level
>> Nested wisdom

One level

Nested wisdom

2.8 水平線(分隔線)

---

渲染結果 ⇒

展開檢視

2.9 表格

| Col A | Col B |
|-------|-------|
|  1    |  2    |
|  3    |  4    |
Col A Col B
1 2
3 4

2.10 任務列表

- [ ] Walk dog
- [x] Write guide
  • Walk dog
  • Write guide

2.11 Emoji

:rocket: :sparkles: :100:

🚀 ✨ 💯

2.12 刪除線

~~obsolete~~ now shiny

obsolete now shiny

2.13 行內 HTML(可摺疊)

<details>
<summary>Click me</summary>
Surprise! 🎈
</details>
Click me Surprise! 🎈

2.14 轉義字元

需要一個字面意義上的 *?使用反斜槓:

\*not italic\*

*not italic*

2.15 註腳

Markdown is handy.[^1]

[^1]: And footnotes are too!

Markdown is handy.1

🎉 大功告成!

現在你已經掌握了 GitHub 風格 Markdown 的要點。把這份速查表放在手邊,很快你就能以光速寫出排版精美的文件。寫作愉快!

探索更多🗺️

要真正精通 Markdown,你應該把它與 HTML 和 CSS 等基礎語言的功能結合起來,並利用額外的擴充。更多功能請參閱 Charles 很酷的演示:

  1. HTML
  2. CSS
  3. LaTeX
  4. Mermaid
  5. JavaScript

請注意,取決於渲染器,這些功能不一定在所有地方都受支援。

參考資料


  1. And footnotes are too!↩