---
title: 入门指南
description: "完成引导式入门流程，创建项目、连接 GitHub、配置 docs.json 并触发首次构建，搭建您的首个文档站点。"
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

## 5 个步骤

<Steps>
  <Step title="开始试用">
    首次登录时，Jamdesk 会自动为您启动 Pro 方案的 **14 天免费试用**。

    - 完整访问所有功能
    - 试用期从激活之日起持续 14 天
  </Step>

  <Step title="创建项目">
    为您的文档项目命名：

    - 使用清晰且具有描述性的名称（例如“API 文档”“用户指南”）
    - 该名称会成为文档站点 URL 的一部分
    - 您可以稍后在项目设置中更改显示名称
  </Step>

  <Step title="连接 GitHub 并创建入门文档">
    Jamdesk 会根据 [入门模板](https://github.com/jamdesk/starter-docs) 创建新的 GitHub 仓库：

    - 包含真实内容和组件的示例页面
    - 预配置的 `docs.json`，包含导航和品牌设置
    - 用于 API 参考文档的 OpenAPI 规范示例
    - 可立即编辑并推送
  </Step>

  <Step title="安装 CLI">
    Jamdesk CLI 支持本地开发：

    ```bash
    npm install -g jamdesk
    ```

    <Note>
    您可以在入门过程中跳过此步骤，随时安装 CLI。即使跳过，您仍然可以直接在 GitHub 上编辑文档。
    </Note>
  </Step>

  <Step title="开始编辑">
    现在可以开始构建了！编辑您的文档：

    - **通过 CLI**：使用 `jamdesk dev` 在本地编辑文件
    - **通过 GitHub**：直接在仓库中编辑 `.mdx` 文件
    - **在 Jamdesk 上**：部分仪表板功能可用（具体取决于方案）

    推送到 GitHub 后，更改会自动触发文档重新构建。
  </Step>
</Steps>

## 入门完成后

完成入门流程后，您可以：
- [创建其他项目](/cn/help/projects/creating)
- [邀请团队成员](/cn/help/projects/team-members)
- [查看分析数据](/cn/setup/analytics-overview)
- [配置自定义域名](/cn/deploy/custom-domains)

## 故障排除

### 我跳过了一步，如何返回？
您可以随时从项目仪表板完成入门流程。找到入门卡片，即可从上次中断的位置继续。

### 我选错了 GitHub 仓库
使用正确的仓库创建新项目。您可以随时删除旧项目。

### 入门过程中需要帮助
您可以随时联系[支持团队](/cn/help/support/contact)。

## 相关文章

<Columns cols={2}>
  <Card title="首次构建" icon="hammer" href="/cn/help/getting-started/first-build">
    触发并验证您的首次构建
  </Card>
  <Card title="仪表板导览" icon="compass" href="/cn/help/getting-started/dashboard-tour">
    了解 Jamdesk 仪表板
  </Card>
</Columns>