端到端教程
从空仓库到上线的文档站点：创建项目、本地预览、部署，并可选配置自定义域名。
从空仓库到上线的文档站点，只需几步。已完成的步骤可以跳过。
前置条件
- 一个 GitHub 账户
- 一个包含文档内容的仓库（或使用 Starter Template）
- 如果要通过 npm 安装 CLI，需要 Node.js 22.18+ 或 24.11+
1
创建项目并连接 GitHub2
使用 CLI 编辑并预览页面在推送到 GitHub 之前，使用 Jamdesk CLI 预览页面修改。
npm install -g jamdesk
cd your-docs
jamdesk dev本地预览地址为 **http://localhost:3000**。更多信息请参阅 本地预览。
在编辑器中打开一个 .mdx 页面，保存修改后刷新本地预览。在下一步中，使用 Git 工作流发布修改。
3
通过推送到 GitHub 进行部署每次推送到已配置的分支都会触发一次构建。构建结果会发布到你的 Jamdesk 子域名。
git add .
git commit -m "Add docs content"
git push origin main将 main 替换为项目中已配置的分支名称。
构建完成后，你的文档将在 your-project.jamdesk.app 上线。详情请参阅 部署。
4
可选：添加自定义域名使用你自己的域名提供文档服务，而不是 Jamdesk 子域名。
- 在 Jamdesk 控制台中前往 Settings → Domains
- 添加你的域名（例如
docs.example.com） - 按照控制台中显示的内容创建 DNS 记录
- 等待验证和 SSL 配置完成
如需排查问题，请参阅 自定义域名。
验证端到端流程
- 你的 Jamdesk 子域名可以正常加载，并显示最新构建
- 本地预览与之展示相同的内容和导航
- 如果已配置，自定义域名已通过验证并使用 HTTPS 提供服务
- 构建历史中显示最新提交及作者信息
可选：托管于 /docs
若要将文档部署在 example.com/docs 这样的子路径下，请参阅 部署概览 和 子路径托管。