website logo
⌘
K
Book a DemoSign Up ->
🌐
Help Center
šŸ’¼
Jobs
šŸš€GETTING STARTED
šŸ‘‹Welcome to Archbee šŸ¤“
Learn the basics
How to get started
šŸ“EDITOR
šŸ“ƒDOCUMENTS
šŸ—ƒļøSPACES
šŸŒŽHOSTED SPACES
šŸ”ƒPUBLIC API
GET
Get document
POST
Update / Create document
DELETE
Delete document
GET
Search document
ā˜•ORGANIZATIONS
šŸ“¦IMPORT & EXPORT
šŸ”ŒINTEGRATIONS
šŸ“„GUIDES
āžæMISC
šŸ™‹Q&A
Docs powered by
Archbee
INTEGRATIONS

GitHub

This feature is available on these plans: āœ”ļø Growing āœ”ļø Scaling āœ”ļø Enterprise

An alternative to using the modern block-based Archbee editor with inline comments and markdown shortcuts is to write the content in GitHub and sync it with Archbee.

For people that use git as a versioning system and write the content of the doc in Github, you can set it up when you add a new Space with the GitHub integration. Here's an example of how to set up (and configure) your Git repo so that we can fetch the content in there and set it up nicely into our software: https://github.com/dragosbulugean/slate Please notice the config .yaml file here if you want to configure the folder where the markdown content will be rendered from (or a summary document tree hierarchy): https://github.com/dragosbulugean/slate/blob/master/.archbee.yaml

How to add the GitHub integration

  1. Go to the Integrations page in your Archbee account.

    Document image
    
  2. Click on the Connect GitHub button to open the login page with GitHub to authorize Archbee.

    Document image
    
  3. Select what you want to sync: All repositories / Only select repositories. Click install.

    Document image
    
  4. After the setup is done, you will be redirected to the Integrations page and you should see GitHub is connected.

    Document image
    
  5. Now when you create a new Space, you have the option to select a repository from the Write in GitHub option.

    Document image
    
  6. After you click Add Space, the content from the selected GitHub repository should be synced.

    Document image
    

Next steps:

  1. See how to Setup the repository
  2. Auto sync your Custom Code from GitHub to Space Settings/Custom Code
  3. Add Code snippets to your GitHub documentation and sync them with Archbee
  4. Markdown syntax for Archbee blocks Editor Markdown Shortcuts



Updated 22 Sep 2023
Did this page help you?
PREVIOUS
Archbee integrations: enhance your team's workflow
NEXT
Setup the repository
Docs powered by
Archbee
TABLE OF CONTENTS
How to add the GitHub integration
Next steps:
Docs powered by
Archbee