快速入门

在 GitBook 中快速设置并在几分钟内发布您的第一个文档站点

本快速入门指南解释了如何在 GitBook 中进行设置并在几分钟内发布您的第一个文档站点。

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

1

入门

您需要 创建一个账户 然后才能开始使用您的第一个文档站点。

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

2

编辑您的内容

在 GitBook 中有两种编辑和更新内容的方式 —— 在我们的可视化编辑器中,或采用文档即代码(docs-as-code)工作流。 您可以选择其中一种,或两者结合使用.

无论您偏好哪种工作流,您都会使用 基于分支的编辑流程。了解更多信息请查看 概念页面.

使用可视化编辑器

GitBook 的所见即所得 (WYSIWYG) 编辑器让您可以可视化地编辑内容,拖动内容块重新组织,并在编辑时查看内容的最终呈现效果。

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

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

首先,在侧边栏找到您的文档站点并点击其下方的项目。这会带您到内容所在的空间。

点击 编辑 位于右上角。此操作会打开一个变更请求,您可以在其中编辑该空间的内容。

点击 添加新内容… 在左侧的目录中添加页面,并为其命名标题。

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.

2. 预览您的更改

在网页版应用的顶部,您会看到以下选项卡: 编辑器, 更改预览。这些用于在不同的内容视图之间切换。

点击 预览 以查看包含变更请求中所有更改后的文档站点在桌面和移动端的实时预览。

A screenshot of the GitBook app with the Preview tab open, showing a docs site being previewed on a mobile-size display

3. 合并您的更改

当您对更改满意后,点击右上角的 合并 按钮。

这将使用变更请求中的所有编辑来更新内容的主要版本。如果该内容是某个实时文档站点的一部分,站点将立即更新。

基于代码的编辑

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

此工作流非常适合不想切换工具并偏好将文档与其他代码一起管理的技术用户。

1. 设置 Git 同步

如果创建站点时尚未设置 Git 同步,首先在侧边栏找到您的文档站点并点击其下方的内容名称。这会带您到内容所在的空间。

点击 设置 Git 同步 位于右上角的按钮,并按照说明将您的空间同步到所选的 Git 仓库。

前往 Git 同步页面 以了解更多信息。

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

将空间与 Git 仓库同步后,您可以在开发环境中从该仓库更新文档内容。

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

Markdown 编辑

GitBook 支持 Markdown 编辑,因此您可以使用常见语法来创建和格式化内容。

GitBook 中的每个标准块都可以使用 Markdown 语法编写和格式化。

3. 预览您的更改

您可以 从 GitHub 或 GitLab 的拉取请求在已发布的文档站点上预览更改

在您的拉取请求中,您会看到带有唯一预览 URL 的状态。点击该状态上的 详细信息 以打开预览 URL,查看拉取请求合并并更新站点后站点的呈现效果。

4. 合并您的更改

一切就绪后,合并您的拉取请求,您的内容将在 GitBook 应用和(如果站点已上线)您的文档站点上更新。

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

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.
3

自定义您的文档

组织站点导航

您可以随时向站点添加更多内容,例如 API 参考、帮助中心或更新日志。添加内容时,您可以组织站点的导航栏,帮助用户更轻松地找到所需内容。

前往 概念页面 以了解有关站点导航的更多信息。

前往 站点结构页面 以了解有关向站点添加内容的更多信息。

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
自定义文档站点的外观和风格

您的文档站点开箱即用就会有良好展示,但您也可以自定义许多设置来更改已发布站点的外观和风格。

您可以自定义站点的 徽标、颜色和字体,使用 站点部分变体向站点导航栏添加内容,更新您的 站点可见性 设置等更多内容。

An illustration showing five docs sites hosted in GitBook, each with distinct visual customizations
4

发布您的文档

发布您的文档

您可以随时点击一次即可发布站点。

通过在侧边栏点击站点名称打开站点仪表板。然后点击 发布 右上角的按钮使其上线。

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

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.
添加自定义域名

默认情况下,您的站点将使用以下格式的唯一 URL 发布:

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

尽管这对一些团队而言可能适用,但许多团队选择将其 URL 更改为 自定义域名自定义子目录.

为此,通过在侧边栏点击站点名称打开站点仪表板,然后打开 设置 选项卡并选择 域名和 URL.

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.

使用屏幕上的按钮选择所需选项,并按照说明向您的域名提供商配置 DNS 设置。

DNS 更改生效可能需要最多 48 小时 —— 虽然通常传播会快得多。

下一步

常见问题

什么是 GitBook?

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

您可以使用支持 Markdown 的高级可视化编辑器编辑内容,将文档与 Git 仓库同步以实现文档即代码的工作流,或两者结合使用。无论您的团队如何选择使用 GitBook,都将使用类似 Git 的分支工作流并保留完整的版本历史,从而在鼓励团队协作和反馈的同时保护主要内容不被意外修改。

如何使用 GitBook 发布文档?

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

  1. 创建一个新的文档站点(或打开现有站点),并选择您要发布的内容。

  2. 选择站点受众。您可以通过 公开 设置向所有人发布,或通过以下方式限制受众: 共享链接认证访问.

  3. (可选)使用内置选项自定义品牌、域名和主题。

  4. 点击 发布。恭喜 —— 您的文档已上线!您可以稍后将更多空间作为站点部分或变体添加。

如需了解更多,请查看 上方的快速入门指南 或阅读 在 GitBook 中创建和发布文档的完整指南.

GitBook 是开源的吗?

GitBook 本身并不是开源的。然而,用于托管和展示文档站点上文档的 GitBook 已发布文档平台是开源的。您可以 访问该仓库 以查看代码并提交更改以供审查。

尽管 GitBook 本身不是开源的, 开源项目可以免费在 GitBook 上发布文档团队可以注册 社区计划 并使用赞助站点计划

发布内容,两者对于符合条件的团队都是免费的。

在 GitBook 中,站点和空间有什么区别? 在 GitBook 中, 文档站点

是您的总体文档中心,承载所有面向受众的内容,并提供可自定义的选项,如主题和域名。 每个站点包含一个或多个空间

,它们作为站点内的独立部分,用于组织相关内容以便更好地模块化和便于管理。空间使您可以将协作聚焦于特定主题,并且您可以在单个站点上组合多个空间以构建结构或启用诸如本地化文档的翻译或多产品支持等选项。

GitBook 的可视化编辑器与 Git 同步有何不同? GitBook 提供两种主要的文档编辑方法 —— 可视化编辑器和 Git 同步。可视化编辑器 是一个高级的基于区块的编辑器,允许您在 GitBook 内使用传统用户界面直接创建和修改内容,并支持 Markdown。它非常适合那些偏好更直观、动手编辑体验而不直接处理代码的用户。

Git 同步 将您的文档工作流与 Git 仓库集成,支持“文档即代码”的方法。此选项非常适合偏好将文档与代码库并行管理并使用熟悉的 Git 命令和工作流的开发者和团队。

您的团队可以选择其中一种工作流,或同时使用两者。无论采用哪种方法,编辑都会遵循一致的类似 Git 的分支工作流,并具有完整的版本历史和内容审查流程。这不仅推动了文档的协作与质量,也保护了主要内容避免意外编辑。

最后更新于

这有帮助吗?