安裝與初始化
官方目前要求 Node.js 22 以上。編輯器建議 VS Code,並安裝官方 Vue 擴充,這樣 .md 裡的 Vue 語法才有提示。
安裝套件
可獨立開一個文件專案,或把 VitePress 加進現有 repo。套件是 ESM-only:package.json 需有 "type": "module",或把設定檔副檔名改成 .mjs/.mts,不要用 require()。
pnpm 用 pnpm add -D vitepress;yarn 用 yarn add -D vitepress vue。
官方文件有時會示範 vitepress@next(預先發佈版)。教學與正式站請先裝穩定版;若要追新功能再改用 @next,並自行承擔 API 變動。
若之後要在 Markdown 裡寫 Vue 元件或呼叫 Vue API,請再明確安裝 vue(yarn 安裝流程已包含)。
執行安裝向導
向導會問:
| 問題 | 常見選擇 |
|---|---|
| 設定檔放哪 | 多數專案選 ./docs,文件與程式碼分開 |
| Markdown 原始檔在哪 | 通常跟設定同一層 ./docs |
| 站名、描述 | 會寫進 config 的 title、description |
| 主題 | 先選 Default Theme,夠做文件站 |
| 是否用 TypeScript | 依團隊習慣;選是會得到 config.mts |
| 是否寫入 npm scripts | 建議選是,之後用 docs:dev 即可 |
完成後 package.json 會多出類似:
{
"scripts": {
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs"
}
}
接著:
瀏覽器開啟 http://localhost:5173,應該會看到範例首頁。若 5173 被占用,終端機印出的實際埠號為準。
不想先裝環境
官方〈快速開始〉提供 StackBlitz 線上專案,可在瀏覽器裡改 Markdown 看結果。
LearnVue 用九分鐘把「安裝 → 路由 → Markdown → 導覽」走一遍。拍攝於 2021 年,請用本頁的 vitepress init,不要照抄影片安裝指令: