Set up the repository
Assuming you've already completed the integration, next step is to set up a repository.
You need to successfully set up and configure your repo so that Archbee can fetch the content in there and set it up nicely on our end.
ο»ΏYou can fork this repository.ο»Ώ
If the system finds a .archbee.yaml file in the root of your repository or other folders (in case you are using multipath) like this .yaml file, then we use that to organize the content.
Pay close attention to the .yaml file here if you want to configure the folder where the markdown content is rendered from (or a summary document tree hierarchy).
ο»ΏCreate aΒ .archbee.yamlΒ file with the following variable structure:ο»Ώ
You must place the file in the root folder of your repository(ies). Make sure that the file stays there as this is your default path for other folders - in case you have multiple folders, you must copy the file to those folders. How, you ask? Check how to sync multiple folders.
- root: ./docs : this property defines where's the directory containing the docs (can be replaced with docsPath: ./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.
- assets: assets : the assets folder is relative to docsPath. Archbee will upload all files found in that folder (code files and images).
- shadowDocs : you need to define the code files/folders to be included as Shadow docs
- ο»ΏpublishSpace : boolean, set to true if you want to publish the space to production portal after each commitο»Ώ
ο»ΏExample of an archbee.yaml config file:ο»Ώ
ο»ΏExample of an archbee.json config file:ο»Ώ
We also recommend that you create a summary.md file. The summary.md reconstructs the document tree in the left navigation panel in Archbee. And it can help you organize your content nicely.
See an example of a summary.md file below:
Some content blocks can be rendered if you are using specific syntax.
Check the Editor Markdown shortcutsο»Ώ to use these shortcuts.
Follow these simple steps to add multiple repositories and sync them with Archbee:
Go to your GitHub account connected with Archbee, and then navigate to the Settings page.
On the left sidebar, look for Applications.
Click the Configure button and when the new page opens, provide access to:
- All repositories (this means that you can select any repo from your Archbee account)
- Only select repositories (select any new repository you want to sync with Archbee)
- Click Save
ο»Ώ
Go back to your Archbee account.
From the left navigation panel, create a new Space -> choose Write in GitHub and select the newly added repositories.
You can actually import Open Api files via GitHub. This feature works exactly like Importing OpenAPI / Swaggerο»Ώ feature, including its settings. There are 2 important things to set up:
- paths to Open Api files (.json, .yml, .yaml) to be written in summary.md config file
- settings to be written in main config file under docTreeOptions:
ο»Ώ
ο»Ώ
