Documentation
Siteforge 文件
從站點配置、內容目錄、主題擴展到 Agent discovery 的 Siteforge 入門路徑。
Get started
先跑通站點,再進入主題
Siteforge 的使用路徑和主流文件站類似:先確認站點級配置和內容目錄,再按頁面類型進入主題層。普通內容維護者只需要理解 Markdown 和 YAML,開發者則可以在主題邊界內完成產品介紹頁、文件頁和互動元件。
config.ymlcontent/themes/<name>dist
Direct use
直接使用
只寫部落格或維護普通內容站時,不需要先理解主題開發。按這個路徑走:
- 克隆專案。
git clone https://github.com/jsw-teams/siteforge.git - 進入目錄。
cd siteforge - 安裝依賴。
npm install - 先做檢查。
npm run check用來確認目前輸出、主題資源和發現入口是健康的。 - 生成靜態文件。
npm run generate類似hexo generate/hexo g。 - 本地預覽。
npm run server類似hexo server/hexo s,預設地址是http://127.0.0.1:4173/。
你會改哪些文件
先從 config.yml 開始:站點名、多語言、導覽、robots、llms、feed、discovery 和第三方腳本都可以在這裡變成結構化輸入。
內容放進 content/:普通頁面用 content/pages,多篇產品文件用 content/docs,文章或鏡像內容繼續放在對應內容目錄。
主題放進 themes/<name>:產品介紹頁的視覺、文件頁的左側導覽、搜尋頁樣式、consent、lightbox、輪播和頁腳都應該先在主題層解決。
Documentation
按階段閱讀文件
開始使用
Siteforge 文件
從站點配置、內容目錄、主題擴展到 Agent discovery 的 Siteforge 入門路徑。
基本操作
頁面與動態 slot
用 content/pages 和 Siteforge slot 低成本定制首頁、搜尋頁和其他特殊頁面。
部署
部署與發布
生成靜態文件,檢查 dist 輸出,並確認部署前的站務資源。
自訂
自訂預設主題
預設主題可直接使用;需要品牌化時先替換內容與 source-assets。
二次開發
主題開發邊界
按 Siteforge 的 theme-first workflow 開發產品介紹與文件站主題。
其他
疑難雜症
預留給常見問題、異常排查和使用邊界。