部署本文档站

在现有 harness-dock 仓库中构建文档,通过 GitHub Pages 或其他静态托管发布。

本地构建与预览#

本站源码独立于 harness-dock 执行服务,仅包含产品文档与静态资源。需要 Node.js 22+,无需安装第三方依赖。在 apps/docs-site/ 目录运行以下命令。

终端
npm run build
npm run preview

预览默认使用 http://localhost:4173。生产构建输出到 dist/。修改 src/content.json 更新文档;修改 public/style.css 调整视觉,public/app.js 管理搜索、主题与复制交互。

部署到 GitHub Pages#

本站位于 harness-dock 仓库的 apps/docs-site/。仓库根目录的 .github/workflows/docs-pages.yml 使用官方 Pages Actions,只构建和上传文档站的 dist 目录。

  1. 仓库满足 Pages 套餐条件后,在 Settings → Pages → Source 选择 GitHub Actions。
  2. 在仓库 Settings → Secrets and variables → Actions → Variables 中设置 DOCS_PAGES_ENABLED=true。
  3. 推送 main 上的文档改动,或手动运行 Docs Pages 工作流。

构建检查默认执行;部署仅在上述变量开启、且来源为 main 时执行。启用前确认当前仓库可见性与账户套餐支持 Pages;实际部署结果以 Actions 输出为准。

项目站点默认路径为 https://hutian-ai.github.io/harness-dock/;此地址是启用后的预期入口,尚未代表已经发布成功。相对路径资源和全文搜索支持该子路径。

部署到静态托管#

平台构建命令发布目录
GitHub Pages官方 Actions 自动构建apps/docs-site/dist
Cloudflare Pagesnpm run builddist
Netlifynpm run builddist(仓库附 netlify.toml)
Vercelnpm run builddist(仓库附 vercel.json)
Nginx / 对象存储本地 npm run build上传 dist 全部内容

页面与资源使用相对路径,支持部署在域名根目录或仓库子路径,无需 SPA 回退重写。全文搜索数据随构建生成,不依赖外部服务。

Docker 部署文档站#

终端
docker build -t harness-dock-docs .
docker run --rm -p 8080:80 harness-dock-docs

打开 http://localhost:8080。镜像只运行静态 Nginx,和 harness-dock server / 设备 Daemon 分别部署。

维护内容#

源码中的 content.json 管理页面标题、摘要、分组和正文 HTML;build.mjs 生成页面、导航、目录与搜索索引。新增或修改页面后重新构建即可。

文档站不包含账户凭据、设备配置或原生会话。对外发布前,将下载入口和版本信息更新为实际可用的发布渠道。

界舟 · Harness Dock · 原生 Harness 接入与执行管理更新于 2026-11-11