寫作指南
本站文件使用 Markdown 編寫，並支援 Frontmatter、提示區塊、程式碼高亮、數學公式等擴充語法。
Frontmatter
在檔案頂部使用 YAML 宣告頁面元資訊：
md
---
title: 頁面標題
description: 頁面描述（用於 SEO）
tags:
- 指南
- Markdown
---
# 正文標題常用欄位：
| 欄位 | 說明 |
|---|---|
title | 頁面標題，會覆蓋導覽列顯示 |
description | 頁面描述，用於搜尋引擎與分享卡片 |
tags | 頁面標籤 |
layout | 頁面佈局，預設 doc，首頁使用 home |
outline | 是否顯示右側目錄 |
提示區塊
md
:::: tip 提示
這是一則提示資訊。
::::
:::: warning 注意
這是一則警告資訊。
::::
:::: danger 危險
這是一則危險資訊。
::::
:::: info 說明
這是一則普通說明。
::::效果預覽：
提示
這是一則提示資訊。
注意
這是一則警告資訊。
危險
這是一則危險資訊。
說明
這是一則普通說明。
程式碼區塊
支援 js、ts、bash、python、json、sql 等常見語言的語法高亮，並支援顯示行號與高亮指定行：
md
```js {2,4-5}
function greet(name) {
const message = `Hello, ${name}!` // 高亮行
console.log(message)
return message
}
```js
function greet(name) {
const message = `Hello, ${name}!` // 高亮行
console.log(message)
return message
}數學公式
使用 KaTeX 渲染數學公式：
md
行內公式 $E = mc^2$
區塊公式：
$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$表格
md
| 方法 | 路徑 | 說明 |
| --- | --- | --- |
| GET | `/api/users` | 取得使用者清單 |
| POST | `/api/users` | 建立使用者 |
| DELETE | `/api/users/:id` | 刪除使用者 |圖片與連結
md
[跳轉到快速開始](./getting-started)元件化擴充
VitePress 支援在 Markdown 中直接使用 Vue 元件，可將複雜互動（圖表、示範、Tab 等）封裝為元件重用。
寫作建議
- 每個文件聚焦一個主題，使用清晰的標題層級（
#→##→###）； - 程式碼範例務必可直接執行，並包含必要的註解；
- 使用提示區塊強調注意事項與邊界情況；
- 關聯文件之間使用相對連結互相跳轉。