# 快速开始

本快速入门指南将介绍如何在 GitBook 中完成设置，并在几分钟内发布你的第一个文档站点。

在本指南结束时，你将拥有一个可访问的文档站点，并可随时扩展和自定义。

{% stepper %}
{% step %}
**开始使用**

你需要 [创建一个账户](https://app.gitbook.com/join) 然后才能开始使用你的第一个文档站点。

创建账户后，你会自动看到一个新的文档站点，已经准备好供你编辑和自定义。在发布之前，请从屏幕上的选项中选择你想如何向站点添加内容。

{% hint style="success" %}
你的内容尚未发布——因此你可以在正式上线前编辑、自定义并预览你的文档站点。点击 **发布** 即可立即上线。

<i class="fa-arrow-down">:arrow-down:</i> [跳转到本页的“发布”部分](#publish-your-documentation)
{% endhint %}
{% endstep %}

{% step %}
**编辑你的内容**

在 GitBook 中编辑和更新内容有两种方式——使用可视化编辑器，或遵循 docs-as-code 工作流。 **你可以二选一，也可以两者结合使用**.

无论你偏好哪种工作流，你都将通过 **基于分支的编辑流程**来编辑内容。更多信息请见 [概念页面](/docs/documentation/zh/zi-yuan/concepts.md).

<details>

<summary>使用可视化编辑器</summary>

GitBook 的所见即所得（WYSIWYG）编辑器让你可以直观地编辑内容、拖拽内容块重新排列，并在工作时查看内容的显示效果。

这种可视化编辑工作流非常适合不想使用代码编辑器的用户，或有使用 Notion、Google Docs 等工具经验的用户。

**1. 在变更请求中编辑你的文档**

首先，在侧边栏中找到你的文档站点，然后点击其下方的项目。这会带你进入内容所在的空间。

点击 **编辑** 右上角的按钮。这会打开一个变更请求，你可以在其中编辑该空间的内容。

点击 **添加新内容…** 在左侧的目录中添加一个页面，并为其命名。

<div data-with-frame="true"><figure><img src="/files/492a51f3b947466f14aaa50c83da8984390d568f" alt="A screenshot of the Editor in the GitBook app, zoomed in to show the menu that lets you add new pages, groups, links and more to a GitBook space."><figcaption></figcaption></figure></div>

**2. 预览你的更改**

在网页应用顶部，你会看到以下选项卡： **编辑器**, **更改** 和 **预览**。这些选项卡可在内容的不同视图之间切换。

点击 **预览** 以查看包含变更请求中所有更改的文档站点实时预览，并在桌面端和移动端上查看显示效果。

<div data-with-frame="true"><figure><img src="/files/9d20f915ed0f584073f12cc23a1a28e0d269004c" alt="A screenshot of the GitBook app with the Preview tab open, showing a docs site being previewed on a mobile-size display"><figcaption></figcaption></figure></div>

**3. 合并你的更改**

当你对更改满意后，点击右上角的 **合并** 按钮。

这会将变更请求中的所有编辑更新到你内容的主版本中。如果内容属于一个已上线的文档站点，站点会立即更新。

</details>

<details>

<summary>基于代码的编辑</summary>

将你的文档与 GitHub 或 GitLab 仓库同步，以启用基于代码的编辑。同步后，你可以在现有开发环境中编辑文档。

这种工作流非常适合不想切换工具、并且更喜欢将文档与其他代码一起管理的技术用户。

**1. 设置 Git Sync**

如果你在创建站点时还没有设置 Git Sync，请先在侧边栏中找到你的文档站点，然后点击其下方内容的名称。这会带你进入内容所在的空间。

点击 **设置 Git Sync** 右上角的按钮，并按照说明将你的空间同步到你选择的 Git 仓库。

前往 [Git Sync 页面](/docs/documentation/zh/getting-started/git-sync.md) 了解更多。

**2. 在你的开发环境中编辑文档**

将你的空间与 Git 仓库同步后，你就可以在开发环境中使用该仓库更新文档内容。

打开仓库，创建一个拉取请求，并进行你想要的更改。

{% hint style="info" %}

#### Markdown 编辑

GitBook 支持 [Markdown 编辑](/docs/documentation/zh/creating-content/formatting/markdown.md)，因此你可以使用常见语法创建和格式化内容。

GitBook 中的每个标准块都可以使用 Markdown 语法进行编写和格式化。
{% endhint %}

**3. 预览你的更改**

你可以 [预览你的更改](/docs/documentation/zh/getting-started/git-sync/github-pull-request-preview.md) ，在 GitHub 或 GitLab 的拉取请求中查看你已发布文档站点上的效果。

在你的拉取请求中，你会看到一个带有唯一预览 URL 的状态。点击该状态上的 **详情** 即可打开预览 URL，并查看当拉取请求合并且站点更新后，你的网站会是什么样子。

**4. 合并你的更改**

可以开始了。合并你的拉取请求后，如果站点已上线，你的内容将同时在 GitBook 应用和文档站点中更新。

在 GitBook 应用中，每次提交以及你已合并的拉取请求都会作为版本历史中的更新同步到你的空间。

<div data-with-frame="true"><figure><img src="/files/4778c514774d50ad941061af5a5a63a786ae14e7" alt="A screenshot of the GitBook app showing the version history side panel open. In the side panel the highlighted entry shows a pull request from GitHub that was merged as part of the history, with a link to view the pull request on GitHub."><figcaption></figcaption></figure></div>

</details>
{% endstep %}

{% step %}
**自定义你的文档**

<details>

<summary>组织你的站点导航</summary>

你可以随时向站点添加更多内容——例如 API 参考、帮助中心或更新日志。当你添加内容时，可以组织站点的导航栏，帮助用户轻松找到他们要找的内容。

前往 [概念页面](/docs/documentation/zh/zi-yuan/concepts.md) 了解更多关于站点导航的信息。

前往 [站点结构页面](/docs/documentation/zh/docs-site/site-structure.md) 了解更多关于向站点添加内容的信息。

<div data-with-frame="true"><figure><img src="/files/0d722fe9ec0b551f72a2f4d7cefe1521eccf5777" alt="A screenshot of a published docs site hosted on GitBook. The top of the site has a navigation bar, and the cursor is hovering over a drop-down in that bar, with a submenu open below it showing links to more pages"><figcaption></figcaption></figure></div>

</details>

<details>

<summary>自定义文档站点的外观和体验</summary>

你的文档站点开箱即用就已经很美观，但你也可以自定义许多设置，以改变已发布站点的外观和体验。

你可以自定义站点的 [Logo、颜色和字体](/docs/documentation/zh/docs-site/customization/icons-colors-and-themes.md)，使用 [站点版块](/docs/documentation/zh/docs-site/site-structure/site-sections.md) 和 [变体](/docs/documentation/zh/docs-site/site-structure/variants.md)将其添加到站点导航栏中，更新你的 [站点可见性](/docs/documentation/zh/docs-site/site-settings.md#audience) 设置等等。

<div data-with-frame="true"><figure><img src="/files/2be2d03fd8fcc4e6d5bd045a2f570d1e25a465ec" alt="An illustration showing five docs sites hosted in GitBook, each with distinct visual customizations"><figcaption></figcaption></figure></div>

</details>
{% endstep %}

{% step %}
**发布你的文档**

<details>

<summary>发布你的文档</summary>

你可以随时一键发布你的站点。

点击侧边栏中的站点名称，打开站点仪表板。然后点击 **发布** 右上角即可上线。

站点上线后，仪表板会更新并显示指向在线站点的链接。

<div data-with-frame="true"><figure><img src="/files/ec25fbaecc076e8f07f334be3bb4addb6d92a403" alt="A screenshot of the GitBook app showing a dashboard for a docs site. The dashboard shows the public URL, site status, site content, some top-level analytics for the site, and other options in tabs along the top of the screen."><figcaption></figcaption></figure></div>

{% hint style="success" %}
想更详细地了解发布流程？请查看 [我们关于在 GitBook 中创建和发布内容的完整指南](/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook.md).
{% endhint %}

</details>

<details>

<summary>添加自定义域名</summary>

默认情况下，你的站点将使用以下格式的唯一 URL 发布：

```
https://[organization-name].gitbook.io/[site-title]
```

虽然这对某些团队来说可能很合适，但许多人会选择将 URL 更改为 [自定义域名](/docs/documentation/zh/docs-site/custom-domain.md) 或 [自定义子目录](/docs/documentation/zh/docs-site/custom-domain/setting-a-custom-subdirectory.md).

为此，请点击侧边栏中的站点名称打开站点仪表板，然后打开 **设置** 选项卡并选择 **域名和 URL**.

<figure><img src="/files/e05aa70441036b03e58c237c6ab2be55d2f7328d" alt="A screenshot of the GitBook app showing the menu that guides you through the process of setting up a custom domain for your docs site."><figcaption></figcaption></figure>

使用屏幕上的按钮选择你想要的选项，并按照说明与你的域名提供商一起配置 DNS 设置。

{% hint style="info" %}
DNS 更改最多可能需要 48 小时才会生效——不过通常传播速度会快得多。
{% endhint %}

</details>
{% endstep %}
{% endstepper %}

### 下一步

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">封面图</th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-type="image">封面图（深色）</th><th data-hidden data-type="image">封面图（深色）</th><th data-hidden data-type="image">封面图（深色）</th><th data-hidden data-type="image">封面图（深色）</th><th data-hidden data-card-cover-dark data-type="image">封面图（深色）</th></tr></thead><tbody><tr><td><strong>邀请你的团队协作</strong></td><td>向你的组织添加团队成员并设置权限</td><td><a href="/files/1e7975547a6499169ae725e2cb36c15b62ec9e30">/files/1e7975547a6499169ae725e2cb36c15b62ec9e30</a></td><td><a href="/pages/72773b530dd0ed92acbaeb8153cb877b26ca1d5b">/pages/72773b530dd0ed92acbaeb8153cb877b26ca1d5b</a></td><td><a href="/files/5466ed2e4a1a0ea93287df3c7d6172a9f1e099b1">/files/5466ed2e4a1a0ea93287df3c7d6172a9f1e099b1</a></td><td><a href="/files/5466ed2e4a1a0ea93287df3c7d6172a9f1e099b1">/files/5466ed2e4a1a0ea93287df3c7d6172a9f1e099b1</a></td><td></td><td></td><td></td></tr><tr><td><strong>更改站点可见性</strong></td><td>通过共享链接和身份验证访问来控制谁可以查看你的内容</td><td><a href="/files/14c14fdea769015f49659d50571789528526e75c">/files/14c14fdea769015f49659d50571789528526e75c</a></td><td><a href="/pages/1d5137752f6c36df1bbc6bed6541212250dcfdf3#publish-a-docs-site">/pages/1d5137752f6c36df1bbc6bed6541212250dcfdf3#publish-a-docs-site</a></td><td><a href="/files/be141b32d869377c74714d36ff0e034e339694e9">/files/be141b32d869377c74714d36ff0e034e339694e9</a></td><td></td><td><a href="/files/be141b32d869377c74714d36ff0e034e339694e9">/files/be141b32d869377c74714d36ff0e034e339694e9</a></td><td><a href="/files/be141b32d869377c74714d36ff0e034e339694e9">/files/be141b32d869377c74714d36ff0e034e339694e9</a></td><td></td></tr><tr><td><strong>添加自动翻译</strong></td><td>创建会自动更新的一键翻译</td><td><a href="/files/2402d3172ae6328acec64382f490f0a0e3854b3c">/files/2402d3172ae6328acec64382f490f0a0e3854b3c</a></td><td><a href="/pages/6e17e6961a0d0cc0bae2cf94b991cab7b8d87c97">/pages/6e17e6961a0d0cc0bae2cf94b991cab7b8d87c97</a></td><td><a href="/files/214762394e96b31de9d03ba5b6713af14115d516">/files/214762394e96b31de9d03ba5b6713af14115d516</a></td><td></td><td></td><td><a href="/files/214762394e96b31de9d03ba5b6713af14115d516">/files/214762394e96b31de9d03ba5b6713af14115d516</a></td><td></td></tr><tr><td><strong>安装集成</strong></td><td>与你的技术栈集成，并通过强大的集成功能扩展能力</td><td><a href="/files/96040376554713f3246648a0e70bfbf1018b1feb">/files/96040376554713f3246648a0e70bfbf1018b1feb</a></td><td><a href="/pages/3363fb91d4d0690deb34e4ac1cccfde33732061d">/pages/3363fb91d4d0690deb34e4ac1cccfde33732061d</a></td><td><a href="/files/d9802dafbbec823d017902ae4e7094e8d79477d6">/files/d9802dafbbec823d017902ae4e7094e8d79477d6</a></td><td></td><td></td><td></td><td><a href="/files/d9802dafbbec823d017902ae4e7094e8d79477d6">/files/d9802dafbbec823d017902ae4e7094e8d79477d6</a></td></tr><tr><td><strong>添加 API 参考</strong></td><td>根据 API 规范创建可自动更新、交互式的 API 参考文档</td><td><a href="/files/260b576e314c66c9339e0087c662087a94963479">/files/260b576e314c66c9339e0087c662087a94963479</a></td><td><a href="/pages/cabca6f326af35f8ba9ae349833b9fe974be2898">/pages/cabca6f326af35f8ba9ae349833b9fe974be2898</a></td><td><a href="/files/c0f1c0bf542662c4b0731dcba4fa3e0f77c8a187">/files/c0f1c0bf542662c4b0731dcba4fa3e0f77c8a187</a></td><td></td><td></td><td></td><td></td></tr><tr><td><strong>跟踪文档分析</strong></td><td>使用内置洞察来衡量成效并了解用户行为</td><td><a href="/files/53a7e214a835d505a0fc24913697fd5543c1bafc">/files/53a7e214a835d505a0fc24913697fd5543c1bafc</a></td><td><a href="/pages/ca9521754948c849d1bd694a3d3674f1e3456343">/pages/ca9521754948c849d1bd694a3d3674f1e3456343</a></td><td><a href="/files/fa1313435f294b4092b3291e0b54b6d306490b90">/files/fa1313435f294b4092b3291e0b54b6d306490b90</a></td><td></td><td></td><td></td><td></td></tr></tbody></table>

### 常见问题

<details>

<summary>什么是 GitBook？</summary>

GitBook 是一个协作式、AI 原生的文档平台，团队可以在这里创建、审阅并发布品牌文档网站。托管在 GitBook 上的文档站点可以提供内置 AI 助手，并通过 MCP 连接到其他 AI 工具。

你可以使用支持 Markdown 的高级可视化编辑器编辑内容，使用 Git 仓库同步文档以实现 docs as code 工作流——或者将两者结合使用。无论你的团队如何选择使用 GitBook，你都将采用类似 Git 的分支工作流，并拥有完整的版本历史，这既能保护你的主内容，又能在整个团队中促进协作与反馈。

</details>

<details>

<summary>如何使用 GitBook 发布文档？</summary>

一旦内容准备好上线，在 GitBook 中发布就是一个简单的过程：

1. 创建一个新的文档站点（或打开现有站点），并选择你要发布的内容。
2. 选择你的站点受众。你可以通过 **公开** 设置向所有人发布，或使用 **共享链接** 或 **身份验证访问**.
3. （可选）使用内置选项自定义品牌、域名和主题。
4. 点击 **发布**。恭喜——你的文档已经上线！你以后可以添加更多空间作为站点版块或变体。

想了解更多，请查看 [我们的快速入门指南](#getting-started) ，或阅读 [在 GitBook 中创建和发布文档的完整指南](/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook.md).

</details>

<details>

<summary>GitBook 是开源的吗？</summary>

GitBook 本身并不是开源的。不过，GitBook 的已发布文档平台——用于在文档站点上托管和展示文档——是开源的。你可以 [访问仓库](https://github.com/GitbookIO/gitbook) 查看代码并提交更改以供审核。

虽然 GitBook 本身不是开源的， **开源项目可以免费在 GitBook 上发布文档**。团队可以注册 [社区计划](/docs/documentation/zh/zhang-hu-guan-li/plans/community.md) 并使用 [赞助站点计划](/docs/documentation/zh/zhang-hu-guan-li/plans/community/sponsored-site-plan.md)发布内容，这两种方案对符合条件的团队均免费。

</details>

<details>

<summary>GitBook 中的 site 和 space 有什么区别？</summary>

在 GitBook 中， **文档站点** 是你的整体文档中心，承载所有可供受众访问的内容，并提供主题和域名等可自定义选项。

每个站点包含一个或多个 **空间**，它们作为站点内的独立版块，组织相关内容，以便更好地模块化和便于管理。空间让你可以专注于特定主题进行协作，而且你可以将多个空间组合到一个站点中，以构建结构或启用诸如翻译（用于本地化文档）或多产品支持等功能。

</details>

<details>

<summary>GitBook 的可视化编辑器和 Git Sync 有什么区别？</summary>

GitBook 提供两种主要的文档编辑方式——可视化编辑器和 Git Sync。 **可视化编辑器** 是一款高级的、基于块的编辑器，允许你使用传统的用户界面直接在 GitBook 中创建和修改内容，并支持 Markdown。它非常适合那些更喜欢直观、动手式编辑体验，而不想直接处理代码的用户。

**Git Sync** 将你的文档工作流与你的 Git 仓库集成，从而支持“docs as code”方法。对于希望将文档与代码库一起管理、并使用熟悉的 Git 命令和工作流的开发者和团队来说，这是理想选择。

你的团队可以选择其中一种工作流，也可以两者结合使用。无论他们偏好哪种方法，编辑都会遵循一致的、类似 Git 的分支工作流，配有完整的版本历史和内容审查流程。这不仅能促进文档的协作和质量，还能保护主内容免受意外编辑。

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://gitbook.com/docs/documentation/zh/getting-started/quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.