Skip to content

Commit

Permalink
assets
Browse files Browse the repository at this point in the history
  • Loading branch information
taranvohra committed Oct 29, 2023
1 parent cec6a3b commit 97e92fc
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 2 deletions.
Binary file added integrations/github/assets/gitbook-github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added integrations/github/assets/github-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added integrations/github/assets/github-sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 24 additions & 2 deletions integrations/github/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,30 @@
name: github
title: GitHub
title: GitHub Sync
organization: gitbook
visibility: public
description: ''
description: Synchronize your GitBook content with GitHub with GitBook’s bi-directional integration.
icon: ./assets/github-icon.png
previewImages:
- ./assets/gitbook-github.png
- ./assets/github-sync.png
externalLinks:
- label: Documentation
url: https://docs.gitbook.com/integrations/git-sync
summary: |
# Overview
GitHub Sync allows technical teams to synchronize GitHub repositories with GitBook and turn Markdown files into beautiful, user-friendly docs. So you can edit directly in GitBook’s powerful editor while keeping content synchronized with your codebase on GitHub — and vice versa.
Head to our documentation to find out more.
# How it works
Because GitHub Sync works both ways, changes you make in GitBook’s editor automatically update in GitHub, and commits in GitHub appear in GitBook. So developers, technical writers, product managers and more can work in their preferred tool without content falling out of sync.
# Configure
First, click Configure in the top-right of your GitBook space and choose GitLab as your provider. You’ll need to authenticate in GitHub, then head back to GitBook and install the integration if you haven’t already. You can then link your GitBook space to a GitHub repository and select the branch you want to sync.
When you make a change in GitBook, it will sync to GitHub as a commit. When you make a change in GitHub, they’ll sync to GitBook as history commits.
Find out more about configuring GitHub Sync in our documentation.
script: src/index.ts
scopes:
- space:metadata:read
Expand Down

0 comments on commit 97e92fc

Please sign in to comment.