FAQ

Last updated 3 months ago

I have a GitHub sync error

In case of errors, make sure that:

  • Your repository has a README.md file at its root (or at the root folder specified in your .gitbook.yaml). This file is required and is used as the homepage for your documentation. For more details, refer to our content configuration.

  • If you have YAML frontmatters in your Markdown files, make sure they are valid using a YAML linter

Do not hesitate to contact us if you still have troubles, it might be a bug or something we can improve in GitBook.

GitBook is not using my docs folder?

By default, GitBook uses the root of the repository as a starting point. A specific directory can be specified to scope the markdown files. See Configuration.

GitBook is creating new markdown files?

When synchronizing and editing from GitBook with an existing GitHub repository, GitBook may create new markdown files instead of using the existing one.

My repository is not listed?

If you do not see some of the repositories that you can access on GitHub, like those of an organization you are part of, check the GitBook OAuth application settings page on GitHub. You will be able to grant (or request for) the GitBook OAuth app access to these repositories in a simple click.

GitBook OAuth application settings on GitHub