快速入门

GitBook 的所见即所得 (WYSIWYG) 编辑器让您以可视化方式编辑内容，拖动内容块进行重新组织，并在编辑时实时查看内容的展示效果。

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

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

首先，在侧边栏找到您的文档站点并点击其下方的项目。这将带您进入存放内容的空间。

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

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

2. 预览您的更改

在 Web 应用顶部，您会看到以下选项卡： 编辑器, 更改 和 预览。这些选项卡在不同视图之间切换，展示您的内容。

点击 预览 以查看变更请求中的所有更改在桌面和移动端上的实时预览，了解您的文档站点将呈现的效果。

3. 合并您的更改

一旦您对更改感到满意，请点击右上角的 合并 按钮。

这将用变更请求中的所有编辑更新主要版本的内容。如果该内容属于已上线的文档站点，站点将立即更新。

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

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

1. 设置 Git 同步

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

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

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

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

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

打开仓库，创建一个拉取请求并进行所需的更改。

3. 预览您的更改

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

在您的拉取请求中，您会看到带有唯一预览 URL 的状态。点击该状态下的 详情 以打开预览 URL，查看当拉取请求合并并且站点更新时站点的展示效果。

4. 合并您的更改

您已准备就绪。合并您的拉取请求后，如果站点已上线，您的内容将在 GitBook 应用和文档站点上同时更新。

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

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

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

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

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

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

您可以随时一键发布站点。

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

站点上线后，仪表板将更新并显示指向在线站点的链接。

默认情况下，您的站点将以以下格式的唯一 URL 发布：

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

虽然这对一些团队来说可能合适，但许多团队选择将其 URL 更改为 自定义域名 或 自定义子目录.

要执行此操作，请在侧边栏点击站点名称打开站点仪表板，然后打开 设置 选项卡并选择 域名和 URL.

使用屏幕上的按钮选择您想要的选项，并按照说明在您的域名提供商处配置 DNS 设置。