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 setup (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ο»Ώ
Go to the Integrations page in your Archbee account.
Click on the Connect GitHub button to open the login page with GitHub to authorize Archbee.
Select what you want to sync: All repositories / Only select repositories. Click install.
After the setup is done, you will be redirected to the Integrations page and you should see GitHub is connected.
Now when you create a new Space, you have the option to select a repository from the Write in GitHub option.
After you click Add Space, the content from the selected GitHub repository should be synced.
Here's the link to the example repo: https://github.com/dragosbulugean/slateο»Ώ
If we find a .archbee.yaml file in the root of the repo like this one https://github.com/dragosbulugean/slate/blob/master/.archbee.yaml, then we use that, or if we don't we just set some defaults.
Create aΒ .archbee.yamlΒ file with the following variable structure. The file must be located in the root of your repository.
- root: ./docs property defines where's the directory containing the docs.
- structure:
- summary: summary.md reconstructs the document tree in the left navigation panel in Archbee. If there is none, we consider the folders to be the categories and mimic the file structure inside.
- readme: Introduction.md we currently use it for the root of the collection when you publish it. For example if you want something at the bare domain or subdomain (without any pathing), you can use this file.
- assets: assets assets folder is relative to docsPath. Archbee will upload all files found from that folder.
Part of the system is still under development for now and we're collecting user feedback.
Test it out and let us know what you thought and how we can improve it!
ο»Ώ