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. 预览你的更改

在 Web 应用的顶部,你会看到用于以下内容的标签页: 编辑器, 更改预览。这些用于在内容的不同视图之间切换。

点击 预览 以查看变更请求中所有更改在桌面和移动端的实时预览,查看你的文档站点将如何展示。

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 同步

如果在创建站点时尚未设置 Git 同步,首先在侧边栏中找到你的文档站点并点击其下方内容的名称。此操作会将你带到存放内容的空间。

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

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

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

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

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

circle-info

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

自定义你的文档

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

你的文档站点开箱即用会有不错的外观,但你也可以自定义许多设置来更改已发布站点的外观和感觉。

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

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 仓库同步以实现文档即代码的工作流——或两者结合使用。无论你的团队选择如何使用 GitBook,都将使用类似 Git 的分支工作流并保留完整的版本历史,这既保护了主要内容,又鼓励整个团队的协作和反馈。

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

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

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

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

  3. 限制受众。

  4. 点击 发布(可选)使用内置选项自定义品牌、域名和主题。

恭喜 —— 你的文档已上线!你可以稍后将更多空间作为站点章节或变体添加。 要了解更多,请查看 上面的快速入门指南,或阅读 在 GitBook 中创建和发布文档的完整指南.

chevron-rightGitBook 是开源的吗?hashtag

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

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

chevron-right在 GitBook 中,站点和空间有什么区别?hashtag

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

每个站点包含一个或多个 空间,它们作为站点内的独立章节,用于组织相关内容以提高模块化和便于管理。空间让你将协作聚焦于特定主题,你也可以在单个站点上组合多个空间以构建结构或启用诸如本地化文档的翻译或多产品支持等选项。

chevron-rightGitBook 的可视化编辑器和 Git 同步之间有什么区别?hashtag

GitBook 提供两种主要的文档编辑方法 —— 可视化编辑器和 Git 同步。可视化编辑器 是一种高级的基于区块的编辑器,允许你使用包含 Markdown 支持的传统用户界面直接在 GitBook 内创建和修改内容。它非常适合那些更喜欢直观的动手编辑体验而不直接处理代码的人。 Git 同步将你的文档工作流与 Git 仓库集成,实现“文档即代码”的方法。该选项非常适合那些更愿意将文档与代码库一起管理、使用熟悉的 Git 命令和工作流的开发者和团队。

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

你的团队可以选择其中一种工作流,或同时结合使用它们。无论他们偏好哪种方法,编辑都遵循一致的类 Git 的分支工作流,并保留完整的版本历史和内容审查流程。这不仅促进了整个文档的协作与质量,而且也保护主要内容免受意外修改。

最后更新于

这有帮助吗?