快速入门
在 GitBook 中快速上手，并在几分钟内发布您的第一个文档站点
本快速入门指南说明如何在 GitBook 中完成设置，并在几分钟内发布您的第一个文档站点。
在本指南结束时，您将拥有一个可实时访问的文档站点，随时可以扩展和自定义。
开始使用
您需要 创建一个帐户 然后才能开始使用您的第一个文档站点。
创建帐户后，您将自动看到一个新的文档站点，已准备好供您编辑和自定义。请在屏幕上的选项中选择发布站点前要添加内容的方式。
您的内容尚未发布 —— 因此您可以在上线前编辑、自定义并预览文档站点。点击 发布 即可立即使其上线。
编辑您的内容
在 GitBook 中有两种编辑和更新内容的方式 —— 使用我们的可视化编辑器，或采用以文档即代码（docs-as-code）的工作流。 您可以选择其中一种，或组合使用两者.
无论您偏好哪种工作流，您都将使用 基于分支的编辑流程. 了解更多信息请参阅 概念页面.
使用可视化编辑器
GitBook 的所见即所得 (WYSIWYG) 编辑器让您以可视化方式编辑内容，拖动内容块进行重新组织，并在编辑时实时查看内容的展示效果。
这种可视化编辑工作流适合不想在代码编辑器中工作的用户，或有使用 Notion 或 Google 文档 等工具经验的用户。
1. 在变更请求中编辑您的文档
首先，在侧边栏找到您的文档站点并点击其下方的项目。这将带您进入存放内容的空间。
点击 编辑 位于右上角。这会打开一个变更请求，在其中您可以编辑该空间的内容。
点击 添加新的… 在左侧的目录中添加页面，并为其命名标题。
2. 预览您的更改
在 Web 应用顶部，您会看到以下选项卡： 编辑器, 更改 和 预览。这些选项卡在不同视图之间切换，展示您的内容。
点击 预览 以查看变更请求中的所有更改在桌面和移动端上的实时预览，了解您的文档站点将呈现的效果。
3. 合并您的更改
一旦您对更改感到满意，请点击右上角的 合并 按钮。
这将用变更请求中的所有编辑更新主要版本的内容。如果该内容属于已上线的文档站点，站点将立即更新。
基于代码的编辑
将您的文档与 GitHub 或 GitLab 仓库同步以启用基于代码的编辑。同步后，您可以在现有的开发环境中编辑文档。
此工作流适合不想切换工具并更愿意将文档与其他代码一起管理的技术用户。
1. 设置 Git 同步
如果您在创建站点时尚未设置 Git 同步，首先在侧边栏找到您的文档站点并点击其下方内容的名称。这会带您进入存放内容的空间。
点击 设置 Git 同步 位于右上角的按钮，并按照说明将您的空间同步到所选的 Git 仓库。
前往 Git 同步 页面 以了解更多信息。
2. 在开发环境中编辑文档
将空间与 Git 仓库同步后，您可以在开发环境中从该仓库更新文档内容。
打开仓库，创建一个拉取请求并进行所需的更改。
Markdown 编辑
GitBook 支持 Markdown 编辑，因此您可以使用通用语法创建和格式化内容。
GitBook 中的每个标准模块都可以使用 Markdown 语法编写和格式化。
3. 预览您的更改
您可以 从 GitHub 或 GitLab 中的拉取请求在已发布的文档站点上预览更改 。
在您的拉取请求中，您会看到带有唯一预览 URL 的状态。点击该状态下的 详情 以打开预览 URL，查看当拉取请求合并并且站点更新时站点的展示效果。
4. 合并您的更改
您已准备就绪。合并您的拉取请求后，如果站点已上线，您的内容将在 GitBook 应用和文档站点上同时更新。
在 GitBook 应用中，每次提交和合并的拉取请求都会作为版本历史中的更新同步到您的空间。
发布您的文档
发布您的文档
您可以随时一键发布站点。
通过在侧边栏点击站点名称打开站点仪表板。然后点击右上角的 发布 以使其上线。
站点上线后，仪表板将更新并显示指向在线站点的链接。
想更深入了解发布流程？请查看 我们关于在 GitBook 中创建和发布内容的完整指南.
下一步
常见问题
什么是 GitBook？
GitBook 是一个协作型、以 AI 为原生的文档平台，团队可以在其中创建、审阅并将品牌文档作为网站发布。托管在 GitBook 上的文档站点可以提供内置的 AI 助手，并通过 MCP 连接到其他 AI 工具。
您可以使用支持 Markdown 的高级可视化编辑器编辑内容，将文档与 Git 仓库同步以采用文档即代码的工作流 —— 或结合两者使用。无论团队如何选择使用 GitBook，您都将使用类似 Git 的分支工作流并拥有完整的版本历史，这在鼓励协作与反馈的同时保护主要内容不被误改。
如何使用 GitBook 发布文档？
当您的内容准备上线后，在 GitBook 中发布是一个简单的流程：
创建一个新的文档站点（或打开现有站点），并选择要发布的内容。
选择站点受众。您可以通过 公开 设置向所有人发布，或通过以下方式限制受众： 共享链接 或 身份验证访问.
（可选）使用内置选项自定义品牌、域名和主题。
点击 发布。恭喜 —— 您的文档已上线！您可以稍后将更多空间作为站点部分或变体添加。
要了解更多，请查看 上面的快速入门指南，或阅读 完整的在 GitBook 中创建和发布文档的指南 GitBook 是开源的吗？.
GitBook 本身并非开源。然而，用于在文档站点上托管和展示文档的 GitBook 已发布文档平台是开源的。您可以
访问该仓库 以查看代码并提交更改以供审查。 尽管 GitBook 本身不是开源的，
开源项目可以在 GitBook 上免费发布文档 。团队可以注册社区计划 并使用 赞助站点计划 发布内容，以上两个计划对符合条件的团队均免费。站点与空间在 GitBook 中有什么区别？
在 GitBook 中，
文档站点 是您的整体文档中心，托管面向受众的所有内容，并具有可自定义的选项，例如主题和域名。 每个站点包含一个或多个
空间 ，这些空间作为站点内的独立部分，组织相关内容以便提高模块化和便于管理。空间让您将协作聚焦于特定主题，您可以在单个站点上组合多个空间以构建结构或启用诸如翻译（用于本地化文档）或多产品支持等选项。GitBook 的可视化编辑器和 Git 同步有何不同？
GitBook 提供两种主要的文档编辑方法 —— 可视化编辑器和 Git 同步。
可视化编辑器 是一个先进的基于模块的编辑器，允许您在 GitBook 内使用传统用户界面直接创建和修改内容，并支持 Markdown。它非常适合那些偏好更直观、动手编辑体验且不想直接处理代码的用户。 Git 同步
将您的文档工作流与 Git 仓库集成，实现“文档即代码”的方式。此选项非常适合希望将文档与代码库一起管理并使用熟悉的 Git 命令和工作流的开发者和团队。 您的团队可以选择其中一种工作流，或两者结合使用。无论采用哪种方法，编辑均遵循一致的类似 Git 的分支工作流，并具备完整的版本历史和内容审查流程。这不仅促进了文档的协作与质量，也可防止主要内容被意外修改。
最后更新于
这有帮助吗？