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

Worker 设置以及 /docs 流量的路由

反向代理

nginx、Apache、Caddy、Traefik 或 HAProxy

Vercel

使用 jd_proxy 标记的 vercel.json 重写规则

分析与监控

分析概览

无需外部脚本即可查看页面浏览量、流量来源和搜索查询

项目分析

以隐私为重点了解网站访客行为

搜索分析

了解读者搜索的内容及其揭示的内容缺口

移动应用

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