Jamdesk Documentation logo

Jamdesk 工作原理

Jamdesk 如何将一次 git push 在 60 秒内变成上线的文档站点,无需您自行运行任何基础设施。

Jamdesk 从您 GitHub 仓库中的 MDX 文件构建文档站点。使用 Markdown 搭配 React 组件编写内容,然后推送到 GitHub。您的站点将在 60 秒内上线到全球 CDN。内容以纯 MDX 文件的形式保存在您的仓库中,您可以随时将其迁移到其他工具。

架构概览

您的仓库是唯一的数据源。Jamdesk 连接到该仓库,构建您的站点,并部署到全球边缘网络。

内容从您的仓库流向用户的过程

构建流程

一次构建通常需要 30–60 秒。Jamdesk 不会预渲染页面,而是将原始内容发送到边缘节点,页面在访客请求时按需渲染。

1
获取源代码

您推送到已连接的 GitHub 分支(或在控制台中点击 Rebuild)。Jamdesk 克隆您的仓库并找到文档目录。

2
验证

Jamdesk 根据 schema 验证 docs.json。它会检查内部链接是否指向失效页面以及锚点是否有误。

3
内容处理

Jamdesk 根据您的内容生成搜索索引、AI 聊天嵌入、站点地图、llms.txt 以及重定向规则。

4
部署到边缘

内容上传到 CDN 并传播到 300 多个边缘节点。仅传输有变更的文件。

每个站点内置的功能

以下功能无需任何配置。

AI 搜索

基于构建时从您的内容生成的向量嵌入进行自然语言搜索。

llms.txt

遵循 llmstxt.org 规范的 AI 可读索引。编程助手和 AI 代理可直接从中读取您的文档。

SEO 基础功能

站点地图、robots.txt、Open Graph 图片和元标签。您的文档从首次部署起即可被索引。

内置分析

无 Cookie 的分析仪表板。您也可以连接 Google Analytics、Plausible、PostHog 等工具。

什么会触发构建

向已连接分支执行 git push、在控制台中点击 Rebuild 按钮,或在 CLI 中运行 jamdesk deploy。Jamdesk 会将短时间内连续推送的提交合并为一次构建。

有关运维细节(状态监控、回滚、分支部署),请参阅构建与部署生命周期。

安全性与基础设施

构建在隔离的容器中运行。构建只读取您的仓库。

最小权限

GitHub App 仅请求您所选仓库的访问权限,不请求组织级别的权限范围。只有当您在编辑器中保存、接受 Fix with AI 的编辑或开启翻译时,Jamdesk 才会写入您的仓库。

隔离构建

每次构建都有独立的容器,部署完成后即被销毁。构建之间以及客户之间不会保留任何数据。

全程 HTTPS

为每个域名自动签发和续期 SSL 证书。

全球 CDN

通过 Cloudflare 网络提供服务,拥有 300 多个边缘节点和 99.9% 的可用性。

性能

加载速度会影响您的文档能否被发现。Google 将 Core Web Vitals 作为排名信号。GPTBot 和 ClaudeBot 等 AI 爬虫为每个页面预留 1–5 秒。无法在该时间窗口内加载的文档不会被引用。

每个 Jamdesk 站点都从边缘节点提供服务,首字节时间(TTFB)低于 50 毫秒。这一速度既满足 Google 的排名阈值,也便于 AI 爬虫抓取和引用。

指标典型值
构建时间30–60 秒
部署传播时间< 30 秒
首字节时间(边缘)< 50 毫秒
完整页面加载< 500 毫秒

后续步骤

创建项目

在控制台中设置新的文档站点

连接 GitHub

关联您的仓库以启用自动构建

本地预览

在推送前使用 Jamdesk CLI 预览和验证您的文档