Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

route-forge/docs

route-forge 系列的文档聚合站,发布在 https://route-forge.github.io/docs/

聚合模型(务必先读)

  • 源文档的唯一事实源在各源仓库route-forge(前端)与 php-laravelphp-common.docs/、README。改文档请去源仓库改,不要在本仓手写任何文档内容
  • 本仓只包含构建脚本(build.mjs)、部署 workflow(.github/workflows/deploy.yml)和站内模板。构建时从各源仓库浅克隆最新 main 渲染为静态 HTML。
  • 触发方式:本仓 push / workflow_dispatch / 源仓库发 repository_dispatch(类型 docs-sync)/ 每日定时兜底。
  • 增删源文档:改 build.mjsSOURCES 清单;增删源仓库build.mjsSOURCESdeploy.yml 的克隆清单两处同步改。
  • 源文件缺失时构建故意失败(红),以便及时发现源仓库结构变化,不做静默丢页。

本地预览

mkdir -p sources
for repo in route-forge/route-forge route-forge/php-laravel route-forge/php-common; do
  git clone --depth 1 "https://github.com/${repo}.git" "sources/$(basename "${repo}")"
done
npm install && npm run build   # 产物在 dist/,任意静态服务器可看

待接入

源仓库发版流水线可加一步 gh api repos/route-forge/docs/dispatches -f event_type=docs-sync,把每日定时兜底变成发布即刷新(两包尚未发版,暂缓)。

About

Route Forge 文档聚合站(GitHub Pages):聚合各仓 .docs 与 README,源文档事实源在各仓库

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages