№ · 发布公告
CH.07.08
📚 同福客栈知识库 wiki 部署指南
静态站点,纯前端,后端只需要能 serve 静态文件即可。
🟢 本地(已默认在跑)
服务器已经在后台跑着了,地址:
http://127.0.0.1:8765/
控制命令(在项目根目录打开 PowerShell):
.\wiki-server.ps1 start # 启动 (后台)
.\wiki-server.ps1 stop # 停止
.\wiki-server.ps1 status # 状态
.\wiki-server.ps1 restart # 重启
.\wiki-server.ps1 open # 在默认浏览器打开主页
⚠️
python别用 store alias,要用C:\Users\xjf\AppData\Local\Programs\Python\Python311\python.exe(已硬编码)。
🔄 增量更新
& "C:\Users\xjf\AppData\Local\Programs\Python\Python311\python.exe" "E:\同福客栈挂机游戏\scripts\docs-to-html\build.py"
输出(每次):
✅ 395 MD + 20 HTML, 32 分类, 26 标签, 7.96 MB
🔄 nav.js 已自动同步 CATEGORY_META(32 个分类)
🚀 公网部署(任选)
docs-site/ 整个目录是部署单元。以下 3 个 zero-config 选项:
方案 A — GitHub Pages(免费,推荐)
- 新建一个空 repo(比如
tongfu-wiki),只 pushdocs-site/内容,根为index.html - Settings → Pages → Branch:
main/(root)→ Save - 3 分钟后
https://<user>.github.io/tongfu-wiki/
方案 B — Cloudflare Pages(免费,国内可访问性最好)
- 登录 https://dash.cloudflare.com → Pages → Connect to Git
- 选 repo → Build settings:
- Build command: 留空
- Build output directory:
docs-site(根目录是仓库根的话) - Root directory:
/(空)
- Deploy
方案 C — 任何 Nginx/Caddy/Apache
把 docs-site/ 当静态根目录就行,不用任何路由配置(因为我们走的是 ?cat= 参数不是 hash)。
🛠️ 故障速查
| 现象 | 排查 |
| :- | :- |
| 搜索无结果 | assets/js/search-index.json 200?F12 看 console |
| 侧栏少了分类 | 跑 build.py 重生 nav.js(应自动同步) |
| category.html?cat=__root__ 404 | 静态服务器 URL 重写?用方案 C 别设 try_files |
| HTML 工具不显示 | 看 docs-site/docs/<同源路径>.html 是否有内容 |
| 标签页空白 | 该标签下确实没文档(build.py 已过滤空标签) |
| 服务器没起来 | python 别用 store 别名 |