Documentation

Siteforge 文件

從站點配置、內容目錄、主題擴展到 Agent discovery 的 Siteforge 入門路徑。

Get started

先跑通站點,再進入主題

Siteforge 的使用路徑和主流文件站類似:先確認站點級配置和內容目錄,再按頁面類型進入主題層。普通內容維護者只需要理解 Markdown 和 YAML,開發者則可以在主題邊界內完成產品介紹頁、文件頁和互動元件。

config.ymlcontent/themes/<name>dist

Direct use

直接使用

只寫部落格或維護普通內容站時,不需要先理解主題開發。按這個路徑走:

  1. 克隆專案。git clone https://github.com/jsw-teams/siteforge.git
  2. 進入目錄。cd siteforge
  3. 安裝依賴。npm install
  4. 先做檢查。npm run check 用來確認目前輸出、主題資源和發現入口是健康的。
  5. 生成靜態文件。npm run generate 類似 hexo generate / hexo g
  6. 本地預覽。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

按階段閱讀文件