跳到內容

這是什麼

EpoCanvas Docs 是 EpoCanvas 專案的官方說明專案。用直白的話講:這個儲存庫交付的就是「說明文件」本身——你現在正在瀏覽的整個網站,就是它的成品。儲存庫裡沒有其他軟體的功能程式碼,你要找的「產品」,就是這個文件網站。


「說明專案」是什麼意思

這個詞有兩層含義,同時成立:

  1. 它是一份說明書。 內容圍繞「是什麼、怎麼用、怎麼改、怎麼上線」展開:閱讀介面怎麼操作、新文件怎麼撰寫、設定改哪裡、部署指令是什麼。寫它只有一個目的——讓拿到 EpoCanvas 的人不用到處問人,照著文件就能把事情做成。
  2. 它本身也是一個能直接執行的網站系統。 把儲存庫 clone 到本機,執行 pnpm install 和 pnpm run dev 兩條指令,就能得到和你眼前一模一樣的站點。整套程式碼基於 Astro 5 與 Starlight,採用 MIT 授權條款,可以整體搬走,改成你自己專案的文件站。

還有一個容易忽略的特點:這份文件介紹的每個功能,你此刻都在親身使用。三欄閱讀佈局、Ctrl + K 全站搜尋、右上角 10 種語言就地切換——文件裡講的就是這個站點自己實作的能力,邊讀邊試即可驗證。


它到底有什麼作用

按讀者身分劃分,這份說明專案承擔三件事:

你是誰它能幫你做什麼建議從哪裡開始
只想查資料的讀者查某個功能怎麼用、某個錯誤怎麼解決頂欄搜尋框或 Ctrl + K 全站搜尋,直接跳到對應章節
想搭自己文件站的開發者提供一套完整可跑的文件站原始碼與部署流程產品簡介 → 快速上手 → 部署上線
參與寫文件的撰寫者規定檔案放哪、格式怎麼寫、圖片怎麼放、如何發布「文件撰寫與內容管理」分組下的三個章節

一句話概括:讓使用者看得懂,讓開發者拿得走,讓撰寫者有章可循。


這份專案包含哪些內容

側邊欄共分五組,各自回答一個問題:

  • 產品概覽與入門:這是個什麼東西?怎麼在本機跑起來?
  • 核心功能與使用指南:閱讀介面、搜尋、多語言、導覽具體怎麼用?
  • 文件撰寫與內容管理:新文件怎麼寫?Markdown 排版和渲染有哪些規則?
  • 設定與客製化:站點標題、導覽選單、主題顏色在哪裡改?元件怎麼改?
  • 發布與維運部署:怎麼發布上線、綁定網域、做 SEO 和版本管理?

每篇文章都是獨立可查的,不必按順序通讀。


兩個常見誤會

誤會一:「這是某個軟體的說明書,我要去找那個軟體本身。」 這個儲存庫裡只有文件站點的原始碼,沒有其他軟體的程式碼;文件實際講解的對象,就是這套文件站點系統自己的使用、客製化與部署。

誤會二:「這是唯讀網站,下載下來也沒什麼用。」 正相反,原始碼在 GitHub 上完全開放,本機兩條指令即可執行;把它當作範本改成自己專案的文件站,正是它設計好的用途之一。


下一步