INTEGRATIONS
GitHub
Sync multiple GitHub folders
6min
if you have multiple folders in your repo that you use for your docs, now you can sync them all with archbee reminder on how to integrate archbee and github in case you need to jog your memory on how to integrate the two , here's a full guide on that up until now, you could only use the archbee yaml file in a single folder and for a single docs project now, you can do so with multiple folders if archbee finds a archbee yaml file in the repository's root or any other folder, we use that to organize the content it's the same file in all folders where you have docs stored here's an example of how to set up and configure your git repo so that archbee can fetch the content in there and set it up nicely into our software > archbee git repo set up the repo refer to our abovementioned archbee repo if the system finds a archbee yaml file in the root of the repo like this one , then we use that to organize the content if not, we'll just set some defaults create yaml file for multiple folders create a archbee yaml file with the following variable structure y ou 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 all other folders root /docs 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 from that folder # this will include all code files from your repo shadowdocs define the code files/folders to be included as shadow docs publishspace boolean, set true to publish the space to production portal after each commit below is an example of an archbee yaml config file with the default path(folder) archbee yaml root /docs structure summary summary md assets assets publishspace true headerincludes | \<script> document getelementbyid("demo") innerhtml = "hello javascript!"; \</script> example of archbee yaml config file with subpaths root folderx structure summary summary md assets assets publishspace true headerincludes | \<script> document getelementbyid("demo") innerhtml = "hello javascript!"; \</script> once you're done, go back to archbee and check if you're able to select multiple folders in the drop down menu we also recommend that you create a summary md file this file reconstructs the document tree in the left navigation panel in archbee and it can help you organise your content nicely see an example of a summary md file below summary md \[introduction]\(1 md) \## table of contents \ \[init]\(init md) \ \[configure app]\(config md) \ \[config database]\(config database md) \ \[config redis]\(config redis md) \ \[config elastic search]\(config es md) \ \[swagger]\(swagger v2 json) sync in archbee when you create a new space, select your repo, changes are automatically synced in archbee if that doesn't work automatically, you can force sync by navigating to space settings > github integration > click the sync with repo button
π€
Have a question?
Our super-smart AI,knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.