For the complete documentation index, see llms.txt. This page is also available as Markdown.

快速入门

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

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

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

1

创建你的账户

创建账户 以开始使用你的第一个文档站点。

2

创建你的第一个站点

  1. 从你的组织中 首页,请点击 + 旁边 站点 在侧边栏中。

  2. 为你的站点起一个访客能够识别的名称。

  3. 点击 创建.

3

选择你想要的开始方式

GitBook 欢迎你来到新站点,并询问你希望如何开始。

起点
最适合

文档模板

从带有占位符分区的现成文档布局开始——这是查看完整站点如何运行的最快方式。

导入

从在线文档、Markdown 或 HTML 中导入现有内容。

OpenAPI

根据 OpenAPI 规范生成交互式 API 参考文档。

空白

从一个空白分区开始,从零构建。

与 Git 同步

将你的文档与 GitHub 或 GitLab 仓库保持同步。

或者,如果你已经在 GitBook 中有一些工作,也可以从你组织的现有内容中选择。

本指南遵循模板路径:

  1. 点击 文档模板 并查看预览。

  2. 点击 使用文档模板 来应用它。

4

探索你的新站点

你的站点会以未发布状态打开,因此你可以在上线前编辑、自定义并预览所有内容。侧边栏显示:

侧边栏区域
你会找到什么

站点页眉

你的网站名称、发布状态以及 预览发布 按钮。

常规

概览, 更改请求, 网站结构,以及 设置.

工具

样式指南, 自定义, 分析,以及 扩展.

内容

这些是你站点的各个分区——对于文档模板来说:主页、文档、API 参考、更新日志和帮助中心。使用 内容 页眉上的图标来查找、重命名和添加分区。

5

编辑你的内容

文档模板会在侧边栏的 内容 部分为你提供占位符分区。点击任意分区将其打开,并查看其中的占位内容。

在 GitBook 中编辑和更新内容有两种方式——在我们的可视化编辑器中,或者遵循 docs-as-code 工作流。 你可以选择其中一种,也可以结合两者使用。 无论你偏好哪种工作流,你都将使用 基于分支的编辑流程进行内容编辑。更多信息请见 概念页面.

GitBook 的所见即所得(WYSIWYG)编辑器可让你直观地编辑内容,拖动内容块以重新排列它们,并在工作时看到内容的实际样子。如果你不想使用代码编辑器,或者你习惯于 Notion 或 Google Docs 之类的工具,这会非常适合你。

在更改请求中编辑你的文档

  1. 内容 侧边栏中的

  2. 点击 编辑 右上角的。这样会打开一个更改请求,你可以在其中修改该分区的内容。

  3. 点击 添加新… > 页面 位于左侧目录中。

  4. 为你的新页面起一个标题。

预览你的更改

在网页应用顶部,你会看到以下标签页: 编辑器, 更改,以及 预览。这些标签页会在内容的不同视图之间切换。点击 预览 即可查看你的文档站点在应用了更改请求中的所有变更后会是什么样子,桌面端和移动端都可以查看。

合并你的更改

当你对更改满意后,点击右上角的 合并 按钮。这会将更改请求中的所有编辑更新到内容的主版本中。如果该内容属于一个在线文档站点,站点会立即更新。

将你的文档与 GitHub 或 GitLab 仓库同步,以便在你现有的开发环境中启用基于代码的编辑。对于喜欢将文档与其他代码一起管理的技术用户来说,这非常理想。

设置 Git 同步

  1. 打开你想要同步的章节,从 内容 侧边栏的

  2. 点击 Git 同步指示器的 设置 按钮。

  3. 按照说明将该章节同步到你选择的 Git 仓库。前往 Git 同步页面 了解更多。

从你的开发环境中编辑文档

将章节同步到你的 Git 仓库后:

  1. 打开仓库。

  2. 创建拉取请求。

  3. 进行你想要的更改。

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

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

预览你的更改

你可以 预览你的更改 在 GitHub 或 GitLab 中通过拉取请求,在你已发布的文档站点上查看。你的拉取请求会显示一个带有唯一预览 URL 的状态。点击 详情 即可打开该状态,并查看合并后的站点效果。

合并你的更改

合并你的拉取请求后,如果你的内容已上线,它会同时在 GitBook 应用和你的文档站点中更新。在 GitBook 应用中,每次提交以及你已合并的拉取请求都会作为版本历史中的更新同步到你的章节。

6

自定义你的文档

整理你的站点导航

随时向你的站点添加更多内容——API 参考、帮助中心、更新日志——并整理站点导航栏,让访客更容易找到他们要找的内容。前往 网站结构 了解分区、组和变体。

自定义外观

你的网站开箱即用时就很出色——而在 自定义下,你可以设置自己的 标志、颜色和字体,调整布局,并更新你的 网站可见性.

7

发布你的文档

你可以随时点击一下发布你的网站。

  1. 从你的组织中打开你的网站 首页.

  2. 点击 发布 在站点页眉中。

一旦你的网站上线, 概览 界面会更新,并显示指向线上站点的链接。

添加自定义域名

默认情况下,你的网站会以以下格式使用一个唯一 URL 发布:

你的网站默认 URL
https://[organization-name].gitbook.io/[site-title]

虽然这可能适合某些团队,但许多人会将其 URL 更改为 自定义域名自定义子目录.

  1. 展开 设置 在你的网站侧边栏中。

  2. 点击 域名和 URL.

  3. 选择你想要的选项。

  4. 按照说明与你的域名提供商一起配置 DNS 设置。

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

后续步骤

Cover

安装集成

与你的技术栈集成,并通过强大的集成功能扩展能力

Cover

添加 API 参考

根据 API 规范创建自动更新的交互式 API 参考文档

最后更新于

这有帮助吗?