创建项目 — Jamdesk Documentation

开始编写文档前，您需要先创建一个项目。您可以从模板开始（Jamdesk 会在 GitHub 或 Bitbucket Cloud 上为您创建仓库），也可以连接已有 docs.json 的现有仓库。无论选择哪种方式，您的网站都能在几分钟内上线。

创建新项目

前往 dashboard.jamdesk.com，使用您的 GitHub 账户登录。

首次使用时，系统会提示您授权 Jamdesk GitHub App。

点击 New Project

在仪表板右上角点击 New Project。

选择起始方式

从预构建模板开始。Jamdesk 会为您创建一个新的 GitHub 仓库，其中已配置示例内容、导航和组件。

默认的 Starter Template 包含示例页面、OpenAPI 规范以及每个组件的示例。将内容替换为您自己的内容即可完成。

配置项目设置

设置项目的基本信息：

字段	说明
Name	在仪表板中显示的名称
Slug	适合用于 URL 的标识符（例如 `my-docs`）
Domain	您的 `*.jamdesk.app` 子域名

最小仓库结构

Jamdesk 项目只需要一个 docs.json 和至少一个页面：

my-docs/
├── docs.json
└── introduction.mdx

docs.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 - 单体仓库中 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	Unlimited
Team	Unlimited	Unlimited

接下来做什么？

连接 GitHub

关联仓库以自动构建

目录结构

构建可扩展的文档结构

单体仓库设置

为单体仓库配置文档路径

端到端教程

按照完整的 Jamdesk 工作流程操作