---
title: Stel die bewaarplek op
slug: stel-die-bewaarplek-op
description: Leer hoe om ’n bewaarplek vir Archbee, ’n dokumentasie-samewerkingsplatform, op te stel met hierdie stap-vir-stap gids. Skep ’n `.archbee.yaml`-lêer met veranderlike strukture en verken voorbeelde van `.yaml`- en `.json`-konfigurasielêers. Ontdek die bela
createdAt: 2023-01-18T13:04:58.000Z
---

## Stel die repository op

Aanvaar dat u reeds [die integrasie voltooi het](https://docs.archbee.com/github#jJpEV), die volgende stap is om 'n repository op te stel.

U moet u repo suksesvol opstel en konfigureer sodat Archbee die inhoud daarin kan haal en dit netjies aan ons kant kan opstel.

:::hint{type="info"}
U kan [hierdie repository fork](https://github.com/dragosbulugean/slate).
:::

As die stelsel 'n `.archbee.yaml`-lêer in die wortel van u repository of ander vouers vind (indien u multipath gebruik), soos hierdie [.yaml-lêer](https://github.com/dragosbulugean/slate/blob/master/.archbee.yaml), gebruik ons dit om die inhoud te organiseer.

:::hint{type="warning"}
Gee noukeurig aandag aan die .[yaml-lêer](https://github.com/dragosbulugean/slate/blob/master/.archbee.yaml) hier as u die vouer wil konfigureer waaruit die markdown-inhoud gerender word (of 'n opsommingsdokument-boomhiërargie).
:::

### Skep .yaml-lêer

Skep 'n `.archbee.yaml` -lêer met die volgende veranderlike struktuur:

:::hint{type="danger"}
U moet die lêer in die wortelvouer van u repository(s) plaas. Maak seker dat die lêer daar bly aangesien dit u verstekpad vir ander vouers is - indien u veelvuldige vouers het, moet u die lêer na daardie vouers kopieer.

Hoe, vra u? Kyk hoe om [veelvuldige vouers te sinkroniseer](https://docs.archbee.com/sync-multiple-github-folders).
:::

### Wat beteken al hierdie sleutels?

- `root: ./docs` : hierdie eienskap definieer waar die gids is wat die dokumentasie bevat (kan vervang word met `docsPath: ./docs`)
- `struktuur:`
  - `opsomming: summary.md` : herbou die dokumentboom in die linkernavigasiepaneel in Archbee. Indien daar nie een is nie, beskou ons die vouers as die kategorieë en boots ons die lêerstruktuur daarin na.
  - `bates: bates`    &#x20;: die assets-vouer is relatief tot `docsPath`. Archbee sal alle lêers wat in daardie vouer gevind word, oplaai (kodelêers en beelde).
- `shadowDocs` : u moet die kodelêers/-vouers definieer wat ingesluit moet word as *Skadudokumente*
- `publishSpace` : boolean, stel op `waar` as u die ruimte na die produksieportaal wil publiseer ná elke commit

Voorbeeld van 'n `archbee.yaml`-konfigurasielêer:

:::CodeblockTabs
archbee.yaml

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

Voorbeeld van 'n `archbee.json`-konfigurasielêer:

:::CodeblockTabs
archbee.json

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

### Skep summary.md-lêer

Ons beveel ook aan dat u 'n `summary.md`-lêer skep. Die `summary.md` herbou die dokumentboom in die linkernavigasiepaneel in Archbee. En dit kan u help om u inhoud netjies te organiseer.

Sien hieronder 'n voorbeeld van 'n `summary.md`-lêer:

:::CodeblockTabs
summary.md

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

```
:::

## Gebruik Markdown-sintaksis met GitHub

Sommige inhoudsblokke kan weergegee word as u spesifieke sintaksis gebruik.

Kyk na die [Redigeerder Markdown-kortpaaie](docId\:POYY3PFUGX_6CVY4L5bWc) om hierdie kortpaaie te gebruik.

## Voeg veelvuldige repositories by

Volg hierdie eenvoudige stappe om veelvuldige repositories by te voeg en dit met Archbee te sinkroniseer:

::::WorkflowBlock
:::WorkflowBlockItem
Gaan na u [GitHub](https://github.com/settings/installations)-rekening wat met Archbee verbind is, en navigeer dan na die **Instellings**-bladsy.

Soek in die linker sybalk vir **Aansoeke.**

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/HChEov2q-7IXyJVa81Mbj_github-appconfigure-light.png "GitHub applications-bladsy")
:::

:::WorkflowBlockItem
Klik die **Konfigureer&#x20;**-knoppie en wanneer die nuwe bladsy oopmaak, verskaf toegang tot:

1. *Alle repositories* (dit beteken dat u enige repo vanaf u Archbee-rekening kan kies)
2. *Slegs geselekteerde repositories* (kies enige nuwe repository wat u met Archbee wil sinkroniseer)
3. Klik Save



![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/zspijTRLT875JPad9Cecf_image.png "Kies repositories")
:::

:::WorkflowBlockItem
Gaan terug na u Archbee-rekening.

Skep vanaf die linker navigasiepaneel 'n nuwe **Ruimte** -> kies **Skryf in GitHub** en selekteer die nuut bygevoegde repositories.
:::
::::

## Voer Open Api-lêers in

U kan Open Api-lêers via GitHub invoer. Hierdie funksie werk presies soos die [Die invoer van OpenAPI / Swagger](docId\:TaIPROVD4f8rfRrKNZwss)-funksie, insluitend sy instellings. Daar is 2 belangrike dinge om op te stel:

- paaie na Open Api-lêers (.json, .yml, .yaml) wat in die `summary.md`-konfigurasielêer geskryf moet word
- instellings wat in die hoofkonfigurasielêer onder `docTreeOptions`: geskryf moet word

:::CodeblockTabs
.archbee.yaml

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

```
:::

