创建项目
从模板创建 Jamdesk 项目，或连接现有 GitHub 仓库。几分钟内，您的网站即可上线至 yourproject.jamdesk.app。
在编写任何文档之前，您需要先创建一个项目。您可以从模板开始，由 Jamdesk 在 GitHub 或 Bitbucket Cloud 上创建仓库；也可以连接一个已包含 docs.json 的现有仓库。您的网站将在几分钟内上线。如需在没有 GitHub 账户的情况下开始，请参阅 无 GitHub 使用文档。
创建新项目
1
登录 Jamdesk前往 dashboard.jamdesk.com，并使用您的 GitHub 账户登录。
首次登录时，Jamdesk 会提示您授权 Jamdesk GitHub App。
2
点击 New Project在仪表板中，点击右上角的 New Project。
3
选择起始方式从预置模板开始。Jamdesk 会创建一个新的 GitHub 仓库，其中已包含示例内容、导航和组件配置。
默认的 Starter Template 包含示例页面、一个 OpenAPI 规范，以及每个组件的示例。您可以将内容替换为您自己的。
4
配置项目设置设置项目的基本信息：
| 字段 | 说明 |
|---|---|
| Name | 仪表板中显示的名称 |
| Slug | 适用于 URL 的标识符（例如 my-docs） |
| Domain | 您的 *.jamdesk.app 子域名 |
最小仓库结构
Jamdesk 项目只需要一个 docs.json 和至少一个页面：
my-docs/
├── docs.json
└── introduction.mdxdocs.json 示例：
docs.json
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}项目设置
在 Settings 中配置您的项目：
General
- Name：更新显示名称
- Slug：更改项目标识符
- Delete Project：永久删除项目
Repository
- Branch：哪个分支会触发部署
- Docs Path：单体仓库（monorepo）中
docs.json的位置
Domain
- Subdomain：您的
*.jamdesk.app网址 - Custom Domain：添加您自己的域名
- Host at a subpath：将文档托管在
/docs或/help等子路径下，而不是站点根目录
Build
- Show Jamdesk Branding：在页脚显示 "Powered by Jamdesk" 链接（默认启用）
- Rebuild：手动触发新的构建
构建设置的更改需要新的构建才能生效。
项目限制
Pro 套餐包含一个项目。如需更多项目，可通过项目附加服务添加，每个每月 15 美元。