GitBook Sync Guide
This repository is prepared for GitBook online reading using Git Sync.
Recommended Setup
- Create or open a GitBook space.
- In the space header, choose
Configure. - Select
GitHub Sync. - Authenticate your GitHub account.
- Install the GitBook GitHub App for the account or organization that owns this repository.
- Select the repository
LessUp/cpp-high-performance-guide. - Select the branch you want to sync, usually
masterin this repository. - For the initial import, choose
GitHub -> GitBookif the repository already contains the documentation.
Repository Configuration
This repository already includes the following files for GitBook:
.gitbook.yamlSUMMARY.mdDOCS.md- Markdown documentation under
docs/
Content Structure
GitBook will use:
DOCS.mdas the first pageSUMMARY.mdas the table of contents
The .gitbook.yaml file explicitly defines this structure.
Notes
- Do not edit the docs entry page from the GitBook UI when Git Sync is enabled. Keep
DOCS.mdmanaged from the repository. - If you do not manually customize the table of contents in GitBook,
SUMMARY.mdwill be used directly. - If you later move your docs under another root folder, update
.gitbook.yamlaccordingly.