快速开始

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

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

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

1

开始上手

你需要先 创建一个账户 然后才能开始搭建你的第一个文档站点。

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

2

编辑你的内容

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

无论你喜欢哪种工作流,你都将使用 基于分支的编辑流程来编辑内容。了解更多请参见 概念页面.

使用可视化编辑器

GitBook 的所见即所得(WYSIWYG)编辑器允许你以可视化方式编辑内容,拖拽内容块进行重排,并在工作时查看内容的呈现效果。

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

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 仓库后,你可以在开发环境中通过该仓库更新文档内容。

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

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 仓库同步以采用 docs-as-code 工作流——或二者结合使用。无论你的团队如何使用 GitBook,你都会使用类似 Git 的分支工作流与完整版本历史,在保护主要内容的同时,鼓励整个团队的协作与反馈。

如何使用 GitBook 发布文档?

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

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

  2. 选择你的站点受众。你可以使用 公开 设置向所有人发布,或通过 分享链接身份验证访问.

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

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

想了解更多,请查看 我们的快速入门指南 (见上文),或阅读 在 GitBook 中创建与发布文档的完整指南.

GitBook 是开源的吗?

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

虽然 GitBook 本身不是开源的, 开源项目可以在 GitBook 上免费发布文档。团队可以注册 社区计划 并使用 赞助站点计划来发布内容,这两者对符合条件的团队均免费。

在 GitBook 中,站点与空间有什么区别?

在 GitBook 中, 文档站点 是你的整体文档枢纽,托管所有你的受众可访问的内容,并提供如主题和域名等可自定义选项。

每个站点包含一个或多个 空间,它们作为站点中的独立分区,用于组织相关内容,以提升模块化与易管理性。空间使你能够将协作聚焦于特定主题,并可在单个站点中组合多个空间以构建结构,或启用诸如翻译(用于本地化文档)或多产品支持等选项。

GitBook 的可视化编辑器与 Git 同步有何不同?

GitBook 提供两种主要的文档编辑方式——可视化编辑器和 Git 同步。 可视化编辑器 是一个高级的、基于区块的编辑器,允许你在 GitBook 内使用包含 Markdown 支持的传统用户界面直接创建和修改内容。它非常适合那些希望拥有更直观、亲手操作的编辑体验,而不直接处理代码的人。

Git 同步 将你的文档工作流与 Git 仓库集成,启用“docs as code”的方式。此选项非常适合希望将文档与代码库并行管理、并使用熟悉的 Git 命令和工作流的开发者及团队。

你的团队可以选择其中一种工作流,或两者结合使用。无论偏好哪种方式,编辑都遵循一致的、类 Git 的分支工作流,具有完整的版本历史和内容评审流程。这不仅促进了整个文档的协作与质量,也能保护主要内容免受意外编辑的影响。

最后更新于

这有帮助吗?