Troubleshooting
In case of errors, make sure that:
- Your repository has a
README.mdfile at its root (or at therootfolder 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.
By default, GitBook uses the root of the repository as a starting point. A specific directory can be specified to scope the markdown files. Take a look at our documentation on content configuration for more details.
When synchronizing and editing from GitBook with an existing Git repository, GitBook may create new markdown files instead of using the existing one.
Make sure that you have installed the GitBook GitHub app to the correct location(s) (when installing the app, you can choose to install it to your personal GitHub, or to any organization you have permissions for) and that you have given the app the correct repository permissions.
Make sure that your access token has been configured with the following access:
- api
- read_repository
- write_repository
Make sure that all the folders in your repo are in lowercase. For example, if you have a folder called
Hello_World GitBook won't sync that folder correctly. Update the name of your folder to all lowercase, and enable sync again.Note: If your repository does not include a
SUMMARY.md file, this article is not for you. Note that if you edited your content from GitBook at least once after setting up Git sync, GitBook should have created this file automatically.If after updating your repository by adding or modifying a markdown file, you do not see the update reflected on GitBook and the sidebar doesn't indicate an error during the sync, your modified file(s) is probably not listed in your
SUMMARY.md file.This could either be because you created the file manually, or because you made an edit on GitBook and the GitBook to Git export phase of the sync created it for you.
The content of this file mirrors your table of contents on GitBook and is used during the Git to GitBook import phase of the sync to recreate your table of contents and re-conciliate upcoming updates from the repository with your existing content on GitBook.
If after ensuring that all your files are included in the
SUMMARY.md file there's still nothing happening on GitBook, don't hesitate to contact support for assistance.Git Sync uses a static IP address for all operations. Having this address could be useful if you'd like to set an extra layer of security to your on-premise instance of GitLab for example. You can whitelist the following IP address
34.136.22.210Last modified 1mo ago