markdown指南与使用

什麼是Markdown？

Markdown 是一種輕量級標記語言，允許人們使用易讀易寫的純文本格式編寫文檔。 它廣泛用於編寫說明文檔、博客文章和技術文檔。

Markdown的優點

  • 簡潔高效：學習成本低，語法簡潔，用文本編輯器即可。
  • 跨平台兼容：所有支持Markdown的平台（如GitHub、知乎、簡書）都能完美渲染，還可轉換為HTML、PDF等多種格式。
  • 版本控制友好：純文本格式，方便用Git進行版本管理。適合筆記、博客、文檔編寫。

Markdown的基本語法速覽

Markdown語法詳解效果
*斜體*用單星號包圍文本斜體
**粗體**用雙星號包圍文本粗體
# 一級標題"#"後需加空格一級標題
## 二級標題以此類推三級標題為三個"#"二級標題
[鏈接](http://a)"[]"內為顯示的超文本鏈接
![圖片](http://url/a.png)"[]"內為圖片名圖片顯示
> 引用" > "後需加空格引用塊
* 無序列表無列表項
1. 有序列表無編號列表
---水平分割線----
`內聯代碼` | 用反引號包圍 | 內聯代碼
```代碼塊開始/結束標記代碼塊
顏色代碼無無
***粗體+斜體***三個星號包圍粗體+斜體
居中格式使用HTML標籤居中文字

語法示例

文本格式化

*這是斜體文本*
**這是粗體文本**
***這是粗體斜體文本***

標題層級

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

鏈接和圖片

[這是一個鏈接](https://www.example.com)
![這是圖片描述](https://example.com/image.jpg)

引用

> 這是一個引用
> 
> 可以有多行

列表

* 無序列表項1
* 無序列表項2
* 無序列表項3

1. 有序列表項1
2. 有序列表項2
3. 有序列表項3

代碼

這是`內聯代碼`的示例

這是代碼塊 可以包含多行代碼

function hello(){
    alert("hello");
}

分割線

---

實用技巧

  • 用標題和列表規劃大綱。
  • 用引用塊添加註釋或補充說明。
  • 常用快捷鍵：
    • 加粗：Ctrl+B/Cmd+B
    • 斜體：Ctrl+I/Cmd+I
    • 插入鏈接：Ctrl+K/Cmd+K
  • 導出為其他格式：可用Typora、VS Code、在線工具導出為HTML、PDF等。
  • 不同編輯器對縮進和空格渲染略有差異，建議預覽檢查。

使用場景

  • 技術文檔編寫：廣泛用於編寫API文檔、用戶手冊和技術說明
  • 博客寫作：許多博客平台（如GitHub Pages、Hexo）支持Markdown格式
  • 筆記記錄：適合用作個人知識管理系統，如Obsidian、Typora等工具
  • 簡歷製作：可以創建結構清晰、易於轉換的簡歷文檔

工具推薦

  • Typora：所見即所得的Markdown編輯器，支持導出多種格式, 新手友好。
  • VS Code：強大的代碼編輯器，安裝Markdown插件後即可使用，程序員必備。
  • MarkText：開源的Markdown編輯器，界面簡潔，支持實時預覽。
  • Dillinger：在線工具，無需安裝。

練習案例

  • 任務：用Markdown寫一篇簡單的日記