Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 2.9 KB

README.md

File metadata and controls

26 lines (18 loc) · 2.9 KB
description
Synchronize your GitBook content with GitHub or GitLab with GitBook’s bi-directional integration.

GitHub & GitLab Sync

Git Sync allows technical teams to synchronize GitHub or GitLab repositories with GitBook and turn Markdown files into beautiful, user-friendly docs. Edit directly in GitBook’s powerful editor while keeping content synchronized with your codebase on GitHub or GitLab.

Git Sync is bi-directional, so changes you make directly in GitBook’s editor are automatically synced, as are any commits made on GitHub or GitLab. This allows developers to commit directly from GitHub or GitLab and technical writers, instructional designers and product managers to edit, discuss and feedback changes directly in GitBook.

{% hint style="info" %} Permissions
Administrators and creators can enable and configure Git Sync. {% endhint %}

Product Demo

{% embed url="https://www.youtube.com/watch?v=939zkInwJHg" %} GitSync Product Demo {% endembed %}

Learn more about

Enabling GitHub SyncLearn how to enable the integration if you’re using GitHubenabling-github-sync.md1 (1).png
Enabling GitLab SyncLearn how to enable the integration if you’re using GitLabenabling-gitlab-sync.md2 (1).png
Content configurationLearn how to configure your content — including structure, summary and re-directscontent-configuration.md3 (1).png
GitHub pull request previewsLearn how to preview the content before merginggithub-pull-request-preview.md4 (1).png
Commit messages & AutolinkLearn how to fine-tune GitSync through commit messagescommits.md5 (1).png
MonoreposLearn how to configure GitSync with a monorepomonorepos.md6 (1).png
TroubleshootingLearn how to resolve common problemstroubleshooting.md7 (1).png