# 快速入门 本快速入门指南将说明如何在几分钟内完成 GitBook 的设置并发布你的第一个文档站点。 在本指南结束时，你将拥有一个可访问的在线文档站点，可随时扩展和自定义。 {% stepper %} {% step %} #### 开始使用 你需要 [创建一个账户](https://app.gitbook.com/join) 然后才能开始创建你的第一个文档站点。 创建账户后，你会自动看到一个新的文档站点，随时可供你编辑和自定义。在发布之前，请根据屏幕上的选项选择你想如何向站点添加内容。 {% hint style="success" %} 你的内容尚未发布——因此你可以在正式上线前编辑、自定义并预览你的文档站点。点击 **发布** 即可立即上线。 :arrow-down: [跳转到本页的“发布”部分](#publish-your-documentation) {% endhint %} {% endstep %} {% step %} #### 编辑你的内容 在 GitBook 中，有两种方式可以编辑和更新内容——使用我们的可视化编辑器，或采用 docs-as-code 工作流。 **你可以选择其中一种，或两者结合使用**. 无论你偏好哪种工作流，你都将使用一种 **基于分支的编辑流程**来编辑内容。了解更多请查看 [概念页面](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/getting-started/concepts).
使用可视化编辑器 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. 合并你的更改** 当你对更改感到满意后，点击 **合并** 按钮（右上角）。 这会将变更请求中的所有编辑更新到内容的主版本中。如果内容属于一个在线文档站点，该站点将立即更新。
基于代码的编辑 将你的文档与 GitHub 或 GitLab 仓库同步，以启用基于代码的编辑。同步后，你就可以在现有开发环境中编辑文档。 这种工作流非常适合不想切换工具、并希望将文档与其他代码一起管理的技术用户。 **1. 设置 Git 同步** 如果你在创建站点时还没有设置 Git 同步，请先在侧边栏中找到你的文档站点，然后点击其下方的内容名称。这会带你进入内容所在的空间。 点击 **设置 Git 同步** 按钮（右上角），并按照说明将你的空间同步到你选择的 Git 仓库。 前往 [Git 同步页面](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/getting-started/git-sync) 了解更多。 **2. 从你的开发环境编辑文档** 一旦你将空间同步到 Git 仓库，就可以在开发环境中从该仓库更新文档内容。 打开仓库，创建一个拉取请求，并进行你想要的更改。 {% hint style="info" %} ### Markdown 编辑 GitBook 支持 [Markdown 编辑](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/creating-content/formatting/markdown)，因此你可以使用常见语法创建和格式化内容。 GitBook 中的每个标准块都可以使用 Markdown 语法编写和格式化。 {% endhint %} **3. 预览你的更改** 您可以 [预览你的更改](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/getting-started/git-sync/github-pull-request-preview) 在 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.
{% endstep %} {% step %} #### 自定义你的文档
整理你的站点导航 你可以随时为站点添加更多内容——例如 API 参考、帮助中心或更新日志。当你添加内容时，可以整理站点的导航栏，帮助用户更轻松地找到他们想要的内容。 前往 [概念页面](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/getting-started/concepts) 了解更多关于站点导航的信息。 前往 [站点结构页面](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/publishing-documentation/site-structure) 了解更多关于向站点添加内容的信息。
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
自定义文档站点的外观和风格 你的文档站点开箱即用就已经很不错，但你也可以自定义许多设置，以改变已发布站点的外观和风格。 你可以自定义站点的 [标志、颜色和字体](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/publishing-documentation/customization/icons-colors-and-themes)，使用 [站点分区](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/publishing-documentation/site-structure/site-sections) 并在 [变体](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/publishing-documentation/site-structure/variants)将其添加到站点导航栏，更新你的 [站点可见性](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/publishing-documentation/site-settings#audience) 设置，以及更多内容。
An illustration showing five docs sites hosted in GitBook, each with distinct visual customizations
{% endstep %} {% step %} #### 发布你的文档
发布你的文档 你可以随时一键发布你的站点。 点击侧边栏中的站点名称打开站点仪表板，然后点击 **发布** （右上角）使其上线。 站点上线后，仪表板将更新，并提供一个在线站点的链接。
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.
{% hint style="success" %} 想更详细地了解发布？查看 [我们关于在 GitBook 中创建和发布内容的完整指南](https://app.gitbook.com/s/LBGJKQic7BQYBXmVSjy0/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook). {% endhint %}
添加自定义域名 默认情况下，你的站点将使用以下格式的唯一 URL 发布： ``` https://[organization-name].gitbook.io/[site-title] ``` 虽然这可能适合某些团队，但许多人会选择将他们的 URL 更改为 [自定义域名](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/publishing-documentation/custom-domain) 或者 [自定义子目录](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/publishing-documentation/setting-a-custom-subdirectory). 为此，点击侧边栏中的站点名称打开站点仪表板，然后打开 **设置** 标签页并选择 **域名和 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 设置。 {% hint style="info" %} DNS 更改生效最多可能需要 48 小时——尽管通常传播速度会快得多。 {% endhint %}
{% endstep %} {% endstepper %} ### 后续步骤
封面图片封面图片（深色）封面图片（深色）封面图片（深色）封面图片（深色）封面图片（深色）
邀请你的团队协作将团队成员添加到你的组织并设置权限25_12_10_invite_your_team_to_collaborate_1.pnginvite-members-to-your-organization25_12_10_invite_your_team_to_collaborate.png25_12_10_invite_your_team_to_collaborate.png
更改站点可见性通过分享链接和身份验证访问控制谁可以查看你的内容25_12_10_change_site_visibility_1.png#publish-a-docs-site25_12_10_change_site_visibility.png25_12_10_change_site_visibility.png25_12_10_change_site_visibility.png
添加自动翻译创建可自动更新的一键翻译25_12_10_add_auto_translations_1.pngsite-settings25_12_10_add_auto_translations.png25_12_10_add_auto_translations.png
安装集成与你的技术栈集成，并通过强大的集成功能扩展能力25_12_10_install_integrations_1.pngji-cheng25_12_10_install_integrations.png25_12_10_install_integrations.png
添加 API 参考根据 API 规范创建可自动更新、可交互的 API 参考文档25_12_10_add_an_api_reference_1.pngapi-references25_12_10_add_an_api_reference.png
跟踪文档分析数据使用内置洞察来衡量成效并了解用户行为25_12_10_track_docs_analytics_1.pnginsights25_12_10_track_docs_analytics.png
### 常见问题
什么是 GitBook？ GitBook 是一个协作式、AI 原生的文档平台，团队可以在其中创建、审阅并发布品牌文档网站。托管在 GitBook 上的文档站点可以提供内置 AI 助手，并通过 MCP 连接到其他 AI 工具。 你可以使用高级可视化编辑器并结合 Markdown 来编辑内容，也可以将文档与 Git 仓库同步，以实现 docs-as-code 工作流——或者两者结合使用。无论你的团队选择如何使用 GitBook，你都将采用类似 Git 的分支工作流，并拥有完整的版本历史，这既能保护你的主内容，又能鼓励整个团队协作和反馈。
如何使用 GitBook 发布文档？ 当你的内容准备好上线后，在 GitBook 中发布是一个简单的过程： 1. 创建一个新的文档站点（或打开现有站点），并选择你要发布的内容。 2. 选择你的站点受众。你可以通过 **公开** 设置向所有人发布，或使用 **分享链接** 或者 **已认证访问**. 3. （可选）使用内置选项自定义品牌、域名和主题。 4. 点击 **发布**。恭喜——你的文档已上线！之后你还可以添加更多空间作为站点部分或变体。 想了解更多，请查看 [我们的快速入门指南](#getting-started) 以上内容，或阅读 [在 GitBook 中创建和发布文档的完整指南](https://app.gitbook.com/s/LBGJKQic7BQYBXmVSjy0/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook).
GitBook 是开源的吗？ GitBook 本身不是开源的。不过，GitBook 的已发布文档平台——用于在文档站点上托管和展示文档——是开源的。你可以 [访问该仓库](https://github.com/GitbookIO/gitbook) 查看代码并提交更改供审核。 虽然 GitBook 本身不是开源的， **开源项目可以免费在 GitBook 上发布文档**。团队可以注册 [社区方案](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/zhang-hu-guan-li/plans/community) 并使用 [赞助站点方案](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/zhang-hu-guan-li/plans/community/sponsored-site-plan)发布内容，这两种方案都对符合条件的团队免费。
GitBook 中站点和空间有什么区别？ 在 GitBook 中， **文档站点** 是你的整体文档中心，承载着所有可供受众访问的内容，并提供主题和域名等可自定义选项。 每个站点包含一个或多个 **空间**，它们作为站点中的独立部分，组织相关内容，以提高模块化和便于管理。空间让你可以围绕特定主题开展协作，而你可以将多个空间组合到一个站点中，以构建结构或启用诸如翻译（本地化文档）或多产品支持之类的功能。
GitBook 的可视化编辑器和 Git 同步有什么区别？ GitBook 提供两种主要的文档编辑方式——可视化编辑器和 Git 同步。 **可视化编辑器** 是一款高级的基于块的编辑器，允许你使用传统用户界面直接在 GitBook 中创建和修改内容，并支持 Markdown。它非常适合那些更喜欢直观、亲自动手的编辑体验，而不想直接处理代码的用户。 **Git 同步** 将你的文档工作流与 Git 仓库集成，支持“docs as code”方法。这个选项非常适合开发者和团队，他们更愿意使用熟悉的 Git 命令和工作流，将文档与代码库一起管理。 你的团队可以选择其中一种工作流，或两者结合使用。无论采用哪种方法，编辑都遵循一致的、类似 Git 的分支工作流，配有完整的版本历史和内容审查流程。这不仅能促进整个文档中的协作和质量，还能保护主内容免受意外编辑。