跳到主要内容

站点维护:本地阅读、更新与部署

这是 Docusaurus 文档站的维护说明,不是 Creator 游戏构建说明。源码位于私有 GitLab 仓库,生成后的静态文档公开访问。

本地使用​

npm ci
npm start

默认开发地址通常是 http://localhost:3000,以终端实际输出为准。只读静态产物可先 npm run build,再 npm run serve。

路径内容
docs37 篇文档,侧栏顺序由 sidebars.ts 管理
static/examples可下载的 TypeScript 示例,与正文展示复用同一源码
static/img/diagramsSVG 教学图
static/img/demosGIF 与静态封面
scripts搜索索引、内容检查、浏览器检查与素材生成
ci / ops部署脚本、可信主机公钥与 Nginx 配置

提交前的检查​

npm run typecheck
npm run check:examples
npm run check:content
npm run build

浏览器检查需要先启动静态站点,可通过 PREVIEW_URL 指定地址,再运行 npm run check:browser。检查包含桌面和窄屏、导航、搜索、Mermaid 与 GIF。素材需要修改时按 scripts/README-visuals.md 复现,无须每次文档提交都重新生成。

GitLab CI 怎样发布​

沿用 ui-power 的静态发布约定,使用独立站点目录。CI 的 SSH 私钥通过受保护 File 变量 PRIVATE_KEY 提供,不写入代码;服务器身份使用已核对的主机公钥,严格校验。

提交号写入 /deployment.txt,验证时不只看 HTTP 200,还要核对是否为本次提交。服务器本地 HTTPS 验证失败会回切旧 release;公网验证失败会使 job 失败,需要按 README 排查,不假定已自动解决所有外部网络故障。

维护边界​

修改 DNS、证书或 Nginx 时保留配置备份,先 nginx -t 再 reload。不要为了文档站构建在服务器上增加常驻 Node 进程。历史 release 用于回滚,清理前先核对 current 和需要保留的版本。

依据:Docusaurus 部署、GitLab SSH File 变量。完整操作与恢复步骤见仓库 README。