website logo
Sign Up ➑Book a Demo
🌐Help Center
πŸ’ΌJobs
Navigate through spaces
⌘K
πŸ‘‹Archbee Documentation Portal
πŸš€GETTING STARTED
Learn the basics
How to get started
Use cases
πŸ“EDITOR
πŸ“ƒDOCUMENTS
πŸ—ƒοΈSPACES
🌎HOSTED SPACES
β˜•ORGANIZATIONS
πŸ“¦IMPORT & EXPORT
πŸ”ŒINTEGRATIONS
πŸ“₯GUIDES
πŸ”ƒPUBLIC API
Doc
➿MISC
πŸ™‹Q&A
How can i arrange and group my imported OpenAPI docs
Why the landing page template isn't publishing to production
Why I can't remove Archbee branding on Startup plan
Why is my published space blank?
Why can't i change the domain?
Docs powered byΒ archbeeΒ 

Setup the repository

6min

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:

archbee.yaml
|
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:

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 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:

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)

ο»Ώ

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.

Updated 19 Jan 2023
Did this page help you?
Yes
No
PREVIOUS
GitHub
NEXT
Custom code
Docs powered byΒ archbeeΒ 
TABLE OF CONTENTS
How to setup the repository
Create a .yaml file
Create a summary.md file
Using Markdown syntax with GitHub