GitHub

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.

   

   

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

   

   

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

   

   

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

   

   

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

   

   

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

   

   

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