GitHub
An alternative to our modern block-based editor with inline comments and markdown shortcuts is to write the content directly in GitHub, and then sync it with Archbee.
For folks that use git as a versioning system and write the content in Github, you can set it up when you add a new Space with the GitHub integration. To connect a space you already have, open its menu and click Sync with Git App.
Integrate GitHub
In your Archbee account, open the organization menu in the top left corner and click Organization Settings. Then open the Configurations page.
Click the GitHub card (Connect GitHub account) to open GitHub and authorize Archbee. Only organization admins can connect GitHub.
Choose what you want to sync: All repositories or Only select repositories. After you've made your selection, click Install.
After the setup is done, you will be redirected to the Configurations page and you should see the ✅ Connected status.
Now when you create a new Space, you can choose between your repositories from the Write in Github option.
After you click Add GitHub-backed Space, Archbee imports the content from the selected GitHub repository.
Next steps
- See how to Set up the repository.
- Learn how later pushes reach the space in Review incoming git changes.
- Auto-sync your Custom Code from GitHub to Space Settings/Custom Code.
- Add code snippets using the Code editor: multi-language block in your GitHub documentation and sync them with Archbee.
- Check out the Markdown syntax for Archbee block in Use Markdown shortcuts.