Onboarding Walkthrough
完成引导式入门流程，搭建首个文档站点：创建项目、连接 GitHub、配置 docs.json 并触发首次构建。
5 个步骤
1
开始试用Jamdesk 会在您首次登录时开启 Pro 方案的 14 天免费试用。
- 所有功能均已开启
- 试用期于激活后 14 天结束
2
创建项目为您的文档项目命名：
- 使用清晰、具有描述性的名称（例如 "API Documentation"、"User Guide"）
- 该名称将成为文档站点 URL 的一部分
- 之后可在项目设置中更改显示名称
3
连接 GitHub 并创建入门文档Jamdesk 会基于 Starter Template 创建一个新的 GitHub 仓库：
- 包含带有真实内容和组件的示例页面
- 预先配置了包含导航和品牌设置的
docs.json - 提供用于 API 参考文档的 OpenAPI 规范示例
- 可直接编辑并推送
4
安装 CLI安装 Jamdesk CLI 以进行本地开发：
npm install -g jamdesk此步骤为可选。您可以随时安装 CLI，或直接在 GitHub 上编辑文档。
5
开始编辑编辑您的文档：
- 通过 CLI：使用
jamdesk dev在本地编辑文件 - 通过 GitHub：直接在仓库中编辑
.mdx文件 - 在 Jamdesk 上：部分仪表板功能可用（取决于方案）
每次推送到 GitHub 都会触发一次重新构建。
入门完成后
接下来，您可以：
故障排除
我跳过了一步，如何返回？
可以。您可以随时从项目仪表板上的入门卡片完成入门设置。
我选错了 GitHub 仓库
请使用正确的仓库创建新项目。您可以随时删除旧项目。
入门过程中需要帮助
请联系支持团队。