$ deploy docs

把文件站
發佈成正式網站

發佈 VitePress、Docusaurus、Nextra、VuePress、MkDocs 等靜態文件建置輸出,保留搜尋友善的 HTML、自訂網域、HTTPS 和可預期的版本路徑。

常見文件站格式

OpenSource
DEV.LIB
SDK_Team
ApiHub
常見痛點

文件站託管常卡住的地方

💸

工具不夠自由

託管型文件工具一開始很方便,但品牌、頁面結構、自訂版面和最終網站控制權常會遇到限制。

🕸️

Wiki 不像正式文件

Wiki 適合筆記。公開產品文件通常還需要搜尋、清楚導覽、自訂網域、metadata 和更好的第一印象。

🔧

自己架會吃掉工程時間

伺服器、SSL、部署 hook 和發佈流程不該和寫文件搶時間。

上線清單

發佈前先檢查建置輸出

上傳產生後的資料夾

Docusaurus 通常輸出 build,VitePress 使用 .vitepress/dist,MkDocs 輸出 site。請上傳產生後的檔案,不是原始 Markdown。

確認 base path

如果文件站放在子路徑或專案路由底下,請確認框架的 base URL 和最後網址一致。

測試搜尋和導覽

先在本機開啟正式 build,檢查搜尋索引、側邊欄連結、版本路徑和深層連結。

讓資源適合快取

文件站常有很多圖片、字型和 JavaScript 小檔案。靜態部署能讓這些資源更容易透過邊緣節點快取。

使用情境

不只適合一種文件

開源專案文件

在品牌網域上發佈教學、changelog 和遷移文件,不必把文件站變成另一個維運專案。

{}

API 參考文件

發佈乾淨的參考文件,保留搜尋、導覽和適合程式碼閱讀的版面,比單純產生的大頁面更好掃讀。

內部知識庫

用清楚的網站結構託管工程手冊、runbook 和流程文件。

產品文件

發佈新手導引、設定教學和功能參考,讓不同地區的客戶都能快速開啟。

設計系統

把元件用法、token 和模式整理成可導覽的網站,隨產品一起擴充。

技術堆疊

支援主流靜態文件工具

VitePress
Docusaurus
VuePress
GitBook CLI
Nextra
Docsify
MkDocs
Hugo
能力
DeployPages
GitBook
GitHub Wiki
自訂網域
內建
通常需付費方案
不是核心能力
搜尋體驗
靜態網站加搜尋整合
內建
有限
樣式控制
完整前端控制
部分可控
很少
版本流程
適合發佈的靜態輸出
內建
以 Git 為主
傳遞速度
全球邊緣傳遞
視方案而定
視情況而定
FAQ

文件站託管常見問題

可以部署 VitePress 或 Docusaurus 輸出嗎?

可以。先執行框架建置,再上傳產生出的靜態輸出資料夾。DeployPages 會提供最後的 HTML、CSS、JavaScript 和資源檔案。

文件站的自訂網域怎麼設定?

部署後新增網域,把 DNS 記錄指向指定目標。DeployPages 會在 DNS 準備好後處理 HTTPS。

可以託管私人文件嗎?

目前最適合公開文件和開放產品文件。存取控制正在擴充,但核心流程仍是靜態發佈。

這對 SEO 有幫助嗎?

有機會。靜態 HTML、乾淨 URL、有效 metadata 和快速傳遞,能替文件的搜尋能見度打好技術基礎。

把文件建置輸出發佈成網站

上傳產生後的文件資料夾,給讀者一個快速、可被品牌識別的查詢入口。

支援 HTML、CSS、JS 和常見靜態文件資源。