Set up the repository

set up the repository assuming you've already https //docs archbee com/github#jjpev , 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 https //github com/dragosbulugean/slate 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 https //github com/dragosbulugean/slate/blob/master/ archbee yaml , then we use that to organize the content pay close attention to the https //github com/dragosbulugean/slate/blob/master/ archbee yaml here if you want to configure the folder where the markdown content is rendered from (or a summary document tree hierarchy) create yaml file 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 https //docs archbee com/sync multiple github folders what do all these keys mean? 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 archbee yaml root doc api structure summary summary md assets assets publishspace true headerincludes | \<script> document getelementbyid("demo") innerhtml = "hello javascript!"; \</script> example of an archbee json config file archbee json { "root" "docfolderwithsummary", "structure" { "summary" "summary md", "assets" " archbee/assets" }, "customjs" "", "customcss" " \n { font family \\"comic sans ms\\", cursive, sans serif; }", "footertemplate" "", "headerincludes" "" } create summary md 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 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) use markdown syntax with github some content blocks can be rendered if you are using specific syntax check the / / /editor/use markdown shortcuts md to use these shortcuts add multiple repositories follow these simple steps to add multiple repositories and sync them with archbee go to your https //github com/settings/installations 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 import open api files you can actually import open api files via github this feature works exactly like / / /import export/importing openapi swagger md 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 archbee yaml docspath /myapp docs structure summary toc md assets assets doctreeoptions openapitryit false showdownloadopenapifile true shouldcreateschemacategory true shouldcreateintro true openapilanguageexamples \ value python label py \ value javascript label js footertemplate "" headerincludes ""