bolt快速入门

在 GitBook 中快速上手,并在几分钟内发布你的第一个文档站点

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

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

1

入门指南

你需要先 创建一个账号arrow-up-right 然后才能开始使用你的第一个文档站点。

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

circle-check
2

编辑你的内容

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

无论你偏好哪种工作流,你都将通过一种 基于分支的编辑流程来编辑内容。了解更多请见 概念页面.

chevron-right使用可视化编辑器hashtag

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. 合并你的更改

当你对更改满意后,点击 合并 按钮,位于右上角。

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

chevron-right基于代码的编辑hashtag

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

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

1. 设置 Git Sync

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

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

前往 Git Sync 页面 了解更多。

2. 从你的开发环境编辑文档

一旦你将空间同步到 Git 仓库,就可以在开发环境中从该仓库更新文档内容。

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

circle-info

Markdown 编辑

GitBook 支持 Markdown 编辑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

自定义你的文档

chevron-right整理你的站点导航hashtag

你可以随时向站点添加更多内容——例如 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
chevron-right自定义文档站点的外观和风格hashtag

你的文档站点开箱即用就会很美观,但你也可以自定义许多设置,从而改变已发布站点的外观和风格。

你可以自定义站点的 Logo、颜色和字体,使用 网站部分变体将其添加到站点导航栏,并更新你的 站点可见性 设置等等。

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

发布你的文档

chevron-right发布你的文档hashtag

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

点击侧边栏中的站点名称,打开站点控制台。然后点击 发布 右上角按钮即可让其上线。

站点上线后,控制台会更新,并提供一个指向在线站点的链接。

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.
circle-check
chevron-right添加自定义域名hashtag

默认情况下,你的站点将通过以下格式的唯一 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 设置。

circle-info

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

下一步

常见问题

chevron-right什么是 GitBook?hashtag

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

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

chevron-right如何使用 GitBook 发布文档?hashtag

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

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

  2. 选择你的站点受众。你可以通过 公开 设置向所有人发布,或者通过 共享链接已认证访问.

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

  4. 点击 发布。恭喜——你的文档已经上线!之后你可以添加更多空间作为站点的版块或变体。

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

chevron-rightGitBook 是开源的吗?hashtag

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

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

chevron-rightGitBook 中站点和空间有什么区别?hashtag

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

每个站点包含一个或多个 空间,它们作为站点内的独立版块,组织相关内容,以获得更好的模块化和更易管理性。空间让你可以将协作聚焦在特定主题上,并且你可以将多个空间组合到一个站点中,以构建结构或启用翻译(用于本地化文档)或多产品支持等功能。

chevron-rightGitBook 的可视化编辑器和 Git Sync 有什么区别?hashtag

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

Git 同步 将你的文档工作流与 Git 仓库集成,使你能够采用“docs as code”方法。这个选项非常适合开发者和团队,他们更愿意使用熟悉的 Git 命令和工作流,将文档与代码库一起管理。

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

最后更新于

这有帮助吗?