티스토리 수익 글 보기

티스토리 수익 글 보기

Git Sync for GitHub, GitLab & docs-as-code | GitBook

Product

Talk to us

Login

Start for free

Talk to us

git sync

Keep your docs and your codebase in sync

Synchronize GitBook with GitHub or GitLab using a two-way Git sync, so developers and writers can contribute through the tools and workflows they already use

Start for free

Talk to us

Meet our customers

Git Sync

Collaborate on docs like you collaborate on code

Git Sync lets your teams update your docs in our visual editor or in code — with everything staying perfectly in sync.

Git Sync

Collaborate on docs like you collaborate on code

Git Sync lets your teams update your docs in our visual editor or in code — with everything staying perfectly in sync.

Your new docs-as-code workflow

Set up a two-way sync between GitBook and a GitHub or GitLab repo to create a docs-as-code workflow that works for everyone. Developers edit Markdown in their IDE, while writers work in GitBook’s visual editor.

Edit anywhere. Update everywhere.

Edit the content of your docs using Markdown in either GitBook or your Git repo and it’ll update the other location. So your docs are always up to date with your latest product releases.

No more context-switching

Don’t make your developers switch tools to document their work. With Git Sync, they can contribute to your docs right in their code editor, while technical writers use our powerful block-based WYSIWYG editor.

Use the Git workflow your team already knows

Work with branches, reviews, and merges just like you do in your codebase. Create a branch in GitBook or your repository, request a review, and merge the changes when they’re ready. Simple.

Use the Git workflow your team already knows

Work with branches, reviews, and merges just like you do in your codebase. Create a branch in GitBook or your repository, request a review, and merge the changes when they’re ready. Simple.

“As a developer-first company, we love that GitBook syncs with GitHub. We’ve integrated our developer docs hosted in GitHub with the rest of our docs easily.”

Ron Cohen

,

CTO & co-founder

Reflag

Read the story

View the docs

“As a developer-first company, we love that GitBook syncs with GitHub. We’ve integrated our developer docs hosted in GitHub with the rest of our docs easily.”

Ron Cohen

,

CTO & co-founder

Reflag

Read the story

View the docs

How Git Sync works

Connect GitBook to GitHub or GitLab, then edit, review, and publish from either side while your content stays in sync.

01

Connect GitBook to a GitHub or GitLab repository

02

Edit Markdown in your repo or in GitBook’s visual editor

03

Use branches, reviews, and merge rules to control what’s published

04

Changes stay in sync across GitBook and your repository

Effortless setup

Syncing made simple

Our GitHub Sync and GitLab Sync integrations guide you through the setup process, so you can get a new sync set up in just a few minutes.

Learn more

Effortless setup

Syncing made simple

Our GitHub Sync and GitLab Sync integrations guide you through the setup process, so you can get a new sync set up in just a few minutes.

Learn more

Smarter collaboration

Bridge the gap between your technical and support teams by making collaboration easier. Now your docs are always up to date and accurate — all you had to do was sync.

Write and export in Markdown

Edit documentation in Markdown in GitBook or directly in your repository. Git Sync keeps both versions aligned, and GitBook makes sure the results always look incredible.

No limits. Sync away.

There’s no limit on how many sites and repos you can sync. So if you have multiple products to document, or want different docs for different customers, you can.

Integrate with your
Git workflows

Custom redirects and commit messages

Set up redirects for pages, or integrate Git Sync into your existing Git flows using Autolink and custom commit messages.

Advanced permissions

Want to choose who can push updates live? Simply set merge permissions in GitHub or GitLab to stay in control of your documentation workflow.

Never start from scratch

Import your current docs straight into GitBook and get a head start on your new docs site. Once the sync starts, everything is set up for you, instantly.

A photo of Selma Bennamane

“We needed a tool that would satisfy both our technical teams that feed documentation like API references, and our customer care team who produces user guides. That was an important factor in choosing GitBook.”

Selma Bennamane

,

Solutions Architect

Batch

Read the story

View the docs

A photo of Selma Bennamane

“We needed a tool that would satisfy both our technical teams that feed documentation like API references, and our customer care team who produces user guides. That was an important factor in choosing GitBook.”

Selma Bennamane

,

Solutions Architect

Batch

Read the story

View the docs

GitHub & GitLab Sync

Synchronize your GitBook docs with GitHub or GitLab with GitBook’s bi-directional integration

Read the docs

FAQs

What is Git Sync?

Git Sync connects GitBook to a GitHub or GitLab repository using a two-way sync, so teams can edit content in GitBook or directly in their repository.

Does GitBook support docs-as-code workflows?

Yes. Developers can write and edit Markdown in GitHub or GitLab while other contributors work in GitBook’s visual editor. Changes stay synchronized across both environments.

Can I use Git branches and pull-request-style workflows?

Yes. GitBook supports branch-based workflows, reviews, merge permissions, and Git-based collaboration so documentation changes can follow a process similar to code changes.

Can I import existing documentation via GitHub or GitLab into GitBook?

Yes. You can connect an existing repository and import your current Markdown content into GitBook, then keep the repository and GitBook synchronized.

Do developers have to leave their code editor to update GitBook?

No. With Git Sync, developers can contribute to documentation directly from the code editor and Git workflow they already use, while technical writers and other contributors can work in GitBook.

Accurate docs. Better answers.

Your docs are already feeding AI. Are users getting the right answers or the wrong ones?

Start for free

Talk to us

Accurate docs. Better answers.

Your docs are already feeding AI. Are users getting the right answers or the wrong ones?

Start for free

Talk to us

Accurate docs. Better answers.

Your docs are already feeding AI. Are users getting the right answers or the wrong ones?

Start for free

Talk to us

Accurate docs. Better answers.

Your docs are already feeding AI. Are users getting the right answers or the wrong ones?

Start for free

Talk to us

Meet our customers