---
title: 创建项目
description: 从模板创建 Jamdesk 项目，或连接现有 GitHub 仓库。几分钟内即可在 yourproject.jamdesk.app 上线。
---
> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.
编写文档前，您需要先创建一个项目。您可以从模板开始（Jamdesk 会为您创建 GitHub 仓库），也可以连接已有 `docs.json` 的现有仓库。无论选择哪种方式，您的网站都能在几分钟内上线。
## 创建新项目
前往 [dashboard.jamdesk.com](https://dashboard.jamdesk.com)，使用您的 GitHub 账户登录。
首次使用时，系统会提示您授权 Jamdesk GitHub App。
在仪表板中，点击右上角的 **New Project**。
从预构建模板开始。Jamdesk 会为您创建新的 GitHub 仓库，其中已配置示例内容、导航和组件。
默认的 [Starter Template](https://github.com/jamdesk/starter-docs) 包含示例页面、OpenAPI 规范以及每个组件的示例。将内容替换为您自己的内容即可完成。
连接现有的 GitHub 仓库：
1. 从下拉菜单中选择仓库
2. 选择要部署的分支（通常为 `main`）
3. 如果 `docs.json` 不在根目录中，请指定其路径
设置项目的基本信息：
| 字段 | 描述 |
|-------|-------------|
| **Name** | 在仪表板中显示的名称 |
| **Slug** | 适合 URL 的标识符（例如 `my-docs`） |
| **Domain** | 您的 `*.jamdesk.app` 子域名 |
## 最小仓库结构
Jamdesk 项目只需要一个 `docs.json` 和至少一个页面：
```bash
my-docs/
├── docs.json
└── introduction.mdx
```
`docs.json` 示例：
```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` URL
- **Custom Domain** - 添加您自己的域名
- **Host at a subpath** - 通过 `/docs` 或 `/help` 等路径提供文档，而不是使用网站根路径
### Build
- **Show Jamdesk Branding** - 在页脚中显示“Powered by Jamdesk”链接（默认启用）
- **Rebuild** - 手动触发新的构建
构建设置更改后，需要进行新的构建才能生效。
## 项目限制
| 计划 | 项目数 | 每月构建次数 |
|------|----------|--------------|
| Free | 1 | 100 |
| Pro | 10 | 无限 |
| Team | 无限 | 无限 |
## 接下来做什么？
关联您的仓库以自动构建
组织文档以支持规模化扩展
为 monorepo 配置文档路径
按照完整的 Jamdesk 工作流程操作