常見問題
如何新增一篇文件?
- 在
docs目錄下建立.md檔案; - 在
docs/.vitepress/config.mjs的sidebar中登記頁面路徑; - 重新整理瀏覽器即可看到新頁面。
詳見快速開始。
如何修改站點標題與主題色?
- 標題:修改
docs/.vitepress/config.mjs中的title; - 主題色:修改
docs/.vitepress/theme/custom.css中的--vp-c-brand-*變數。
如何啟用或關閉全文搜尋?
搜尋設定位於 docs/.vitepress/config.mjs 的 themeConfig.search 欄位,設定 provider: 'local' 啟用本機搜尋,移除該欄位即可關閉。
文件支援深色模式嗎?
支援。站點預設跟隨系統外觀,也可透過右上角切換按鈕手動切換,無需額外設定。
如何部署到自己的伺服器?
將 npm run docs:build 產出的 docs/.vitepress/dist 目錄託管到任意靜態伺服器(Nginx、物件儲存等)即可。詳見部署發布。
如何為文件新增多版本切換?
VitePress 官方文件的版本化方案是透過多份靜態建置 + 自訂導覽來實作,也可借助社群外掛(如 vitepress-versioning)快速整合。
遇到建置報錯怎麼辦?
常見排查步驟:
- 檢查 Node 版本是否為 18 及以上:
node -v; - 刪除快取後重新建置:
rm -rf docs/.vitepress/cache docs/.vitepress/dist; - 重新安裝依賴:
rm -rf node_modules && npm install; - 查看完整錯誤堆疊定位具體檔案。
如何自訂頁尾?
修改 docs/.vitepress/config.mjs 中 themeConfig.footer 的 message 與 copyright 欄位。