Jamdesk Documentation logo

构建、部署与分析概览

文档从 git push 到上线的完整流程:CLI、构建流水线、托管与自定义域名,以及每个页面自带的分析功能。

推送到 GitHub(或运行 jamdesk deploy)。Jamdesk 会构建网站,更改随即上线。本节介绍 CLI、构建过程中发生的事情、网站的托管位置,以及 Jamdesk 在每个页面上无需额外脚本即可收集的分析数据。

构建失败? 构建故障排除 将常见错误信息与原因和解决方法对应起来。

CLI

开源 CLI 可在本地预览文档、验证配置、检查失效链接并进行部署。

CLI 概览

安装 CLI 并了解核心命令

身份验证

登录、令牌存储与会话管理

CLI 部署

jamdesk deploy 如何打包、上传并构建你的文档

修复失效链接

jamdesk fix 修复失效的内部链接,并先预览更改

构建工作流

部署工作流

GitHub 推送、CLI 部署、状态跟踪与手动重新构建

触发构建

推送时自动触发、从仪表板手动触发,以及防抖与队列

监控构建

实时进度、构建阶段与结构化日志

使用 AI 修复

在构建仪表板中审查并应用 AI 建议的修复

自动图片转换

构建时将 PNG 和 JPG 转换为 WebP

PDF 导出

将整个网站导出为一个 PDF

托管与域名

你的网站默认位于 yourproject.jamdesk.app。你可以使用自己的域名提供服务,也可以在现有网站的 /docs 路径下提供服务。

部署概览

子域名、自定义域名或子路径:比较各种托管选项

构建与部署生命周期

从 git push 到网站上线的完整流水线

自定义域名

配置 DNS,使用带 SSL 的自有域名提供文档

仅使用自定义域名

阻止 Jamdesk 子域名直接响应访问

Jamdesk 子域名

命名规则以及如何更改默认子域名

子路径托管

托管在 yoursite.com/docs,而非单独的子域名

平台指南

经过测试的配置,用于通过现有基础设施代理 /docs。

AWS Route 53 与 CloudFront

分发设置与源站配置

Cloudflare Workers

为 /docs 流量设置 Worker 与路由

反向代理

nginx、Apache、Caddy、Traefik 或 HAProxy

Vercel

带有 jd_proxy 标记的 vercel.json 重写规则

分析与监控

分析概览

页面浏览量、流量来源与搜索查询,无需外部脚本

项目分析

网站访客行为分析,注重隐私保护

搜索分析

读者搜索的内容,以及由此暴露的内容缺口

移动应用

随时查看构建状态与分析数据,并接收推送通知