Setup the repository

How to setup the repository

Here's the link to the example repo: https://github.com/dragosbulugean/slate

If Archbee finds 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 to organize the content, or if we don't, we just set some defaults.

Create a .yaml file

Create a .archbee.yaml file with the following variable structure. The file must be located at 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 the assets folder is relative to docsPath. Archbee will upload all files found from that folder.

Example of an archbee.yaml config file:

root: doc-api
structure:
  summary: summary.md
  assets: assets
headerIncludes:  |
  <script>
  document.getElementById("demo").innerHTML = "Hello JavaScript!";
  </script> 

Example of an archbee.json config file:

{
  "root": "docfolderwithsummary",
  "structure": {
    "summary": "summary.md",
    "assets": ".archbee/assets"
  },
  "customJS":"",
  "customCSS":"* \n {  font-family: \"Comic Sans MS\", cursive, sans-serif; }",
  "footerTemplate": "",
  "headerIncludes": ""
}

Create a summary.md file

The summary.md reconstructs the document tree in the left navigation panel in Archbee. It is recommended to have a summary, as it can help you organise your content nicely. See an example of a summary.md below:

- [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)

Using Markdown syntax with GitHub

Some of the blocks Archbee's editor support can be rendered if you are using specific syntax.

Check the Editor Markdown Shortcuts to use the shortcuts.