内容配置

使用额外功能配置 Git 同步

如果你想进一步配置 Git Sync，可以添加一个 .gitbook.yaml 文件到仓库根目录，以告诉 GitBook 如何解析你的 Git 仓库。

.gitbook.yaml

root: ./

​structure:
  readme: README.md
  summary: SUMMARY.md​

redirects:
  previous/page: new-folder/page.md

根目录

用于查找文档的路径默认是仓库的根目录。以下是如何让 GitBook 查找一个 ./docs 文件夹：

.gitbook.yaml

root: ./docs/

所有其他指定路径的选项都将相对于这个根文件夹。因此，如果你将 root 定义为 ./docs/ 然后将 structure.summary 设为 ./product/SUMMARY.md，GitBook 实际上会在 ./docs/product/SUMMARY.md中查找文件。‌

​结构‌

结构接受两个属性：‌

• readme：你的文档的首页。其默认值为 ./README.md

• summary：你的文档目录。其默认值为 ./SUMMARY.md

这些属性的值是对应文件的路径。该路径相对于“root”选项。例如，以下是如何让 GitBook 查找一个 ./product 文件夹中的首页和目录：

.gitbook.yaml

structure:
  readme: ./product/README.md
  summary: ./product/SUMMARY.md

当启用 Git Sync 时， 请记住不要通过 GitBook 的界面创建或修改 readme 文件 。readme 文件应完全由你的 GitHub/GitLab 仓库管理，以避免冲突和重复问题。

摘要‌

该 summary 文件是一个 Markdown 文件（.md），应具有以下结构：

./SUMMARY.md

‌# 摘要​

## 使用标题来创建像这样的页面分组​

* [第一页标题](page1/README.md)
    * [某个子页面](page1/page1-1.md)
    * [另一个子页面](part1/page1-2.md)

* [第二页标题](page2/README.md)
    * [某个子页面](page2/page2-1.md)
    * [另一个子页面](part2/page2-2.md)

## 第二页分组​

* [另一页](another-page.md)

提供自定义摘要文件是可选的。默认情况下，GitBook 会在 SUMMARY.md 中查找一个名为 root 的文件夹内（如果你的配置文件中指定了），否则就在仓库根目录中查找。

如果你不指定摘要，并且 GitBook 没有在你的文档根目录中找到一个 SUMMARY.md 文件，GitBook 将根据文件夹结构和下面的 Markdown 文件推断目录。‌

摘要 Markdown 文件是 的镜像 目录 ，对应你的 GitBook 空间。因此，即使在首次导入时没有提供摘要文件，GitBook 也会创建一个，并且在你使用 GitBook 编辑器更新内容时更新它。

因此，在你的 SUMMARY.md 文件中无法两次引用同一个 Markdown 文件，因为这意味着同一页面在你的 GitBook 空间中对应两个不同的 URL。

目录（侧边栏）标题

如果你希望页面在目录侧边栏中的标题与页面本身的标题不同，可以定义一个可选的 页面链接标题 中查找一个名为 SUMMARY.md 文件。

如果你使用 Git Sync，页面链接标题是在页面链接中设置的：

./SUMMARY.md

# 摘要

* [页面主标题](page.md "页面链接标题")

引号内的文本（"页面链接标题"）将用于：

• 在目录（侧边栏）中

• 在每个页面底部的分页按钮中

• 在你添加到该页面的任何相对链接中

页面链接标题是可选的——如果你不手动添加，GitBook 默认会在所有地方使用页面的标准标题。