If you'd like to configure GitSync further, you can add a
.gitbook.yamlfile at the root of your repository to tell GitBook how to parse your Git repository.
Here is an example:
Path to lookup for your documentation defaults to the root directory of the repository. Here's how you can tell GitBook to look into a
All other options that specify paths will be relative to this root folder. So if you define root as
./product/SUMMARY.md, GitBook will actually look for a file in
The structure accepts two properties:
- readme: Your documentation's first page. Its default value is
- summary: Your documentation's table of content. Its default value is
The value of those properties is a path to the corresponding files. The path is relative to the "root" option. For example, here's how you can tell GitBook to look into a
./productfolder for the first page and summary:
summaryfile is a Markdown file (
.md) that should have the following structure:
## Use headings to create page groups like this one
* [First page's title](page1/README.md)
* [Some child page](page1/page1-1.md)
* [Some other child page](part1/page1-2.md)
* [Second page's title](page2/README.md)
* [Some child page](page2/page2-1.md)
* [Some other child page](part2/page2-2.md)
## A second-page group
* [Yet another page](another-page.md)
Providing a custom summary file is optional. By default, GitBook will look for a file named
rootfolder if specified in your config file, or at the root of the repository otherwise.
If you don't specify a summary, and GitBook does not find a
SUMMARY.mdfile at the root of your docs, GitBook will infer the table of contents from the folder structure and the Markdown files below.
The summary markdown file is a mirror of the table of contents of your GitBook space. So even when no summary file is provided during an initial import, GitBook will create one and/or update it whenever you update your content using the GitBook editor.
Due to this, it is not possible to reference the same markdown file twice in your
SUMMARY.mdfile, because this would imply that a single page lives at two different URLs in your GitBook space.
Redirects are commonly used when you are migrating your documentation from one provider to another, for example when you just moved your docs to GitBook. Broken links can impact your SEO so we recommend setting up redirects where needed.
When moving your content within GitBook, most URLs should work as expected depending on complexity of the change. There are a number of tools that will allow you to verify which (if any) links were broken.
With Git, when a file is moved many times, the file is removed and a new one is created. This makes it impossible for GitBook to know that a folder has been renamed for example. Make sure to double-check and add redirects where needed.
You can create custom redirects of a URL to a page by specifying the path to the corresponding file. The path is relative to the "root" option. For example, here's how you can tell GitBook to redirect users accessing a past url
/helpto a new url
https://docs.company.com/helpwhich has now moved to
misc/support.mdneeds to be a real existing path within the repository. It needs to be relative to the current
.gitbook.yaml. Please don't add any leading slashes. For example,
./misc/support.mdwill not work.
YAML file need to be correctly formatted for the redirects to work. This means incorrect indentation or whitespace can result in your redirects not working. Validating your YAML file can ensure that the redirects will work smoothly.