端到端教程
从空仓库到上线文档站点：创建项目、本地预览、部署，并可选配置自定义域名。
从空仓库开始，搭建上线的文档站点。准备好后添加自定义域名，已经完成的步骤可以跳过。
前置条件
- 一个 GitHub 账户
- 一个包含文档内容的仓库（或使用起始模板）
- 如果希望使用 npm 安装 CLI，需要 Node.js 20+
1
创建项目并连接 GitHub2
使用 CLI 编辑并预览页面使用 Jamdesk CLI 在将页面更改推送到 GitHub 前进行预览。
npm install -g jamdesk
cd your-docs
jamdesk dev本地预览运行于 **http://localhost:3000**。详情请参阅[本地预览](/cn/development/local-preview)。
在编辑器中打开 .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 这样的子路径上提供文档，请查看部署概览和子路径托管。