Määritä repositorio

9 min

Määritä repository

Olettaen, että olette jo suorittaneet integraation, seuraava vaihe on määrittää repository.

Teidän täytyy määrittää ja konfiguroida repo onnistuneesti, jotta Archbee voi hakea siellä olevan sisällön ja asettaa sen oikein meidän puolellamme.

Voitte forkata tämän repositoryn.

Jos järjestelmä löytää .archbee.yaml -tiedoston repositorynne juuresta tai muista kansioista (jos käytätte multipathia) tällaisen .yaml-tiedoston tavoin, käytämme sitä sisällön järjestämiseen.

Kiinnittäkää erityistä huomiota tässä olevaan .yaml-tiedostoon , jos haluatte määrittää kansion, josta markdown-sisältö renderöidään (tai yhteenvedon dokumenttipuuhierarkian).

Luo .yaml-tiedosto

Luo .archbee.yaml-tiedosto seuraavalla muuttujarakenteella:

Teidän täytyy sijoittaa tiedosto repositorynne juurikansioon/-kansioihin. Varmistakaa, että tiedosto pysyy siellä, koska tämä on oletuspolkunne muille kansioille - jos teillä on useita kansioita, teidän täytyy kopioida tiedosto niihin kansioihin. Miten? Katsokaa, kuinka synkronoidaan useita kansioita.

Mitä kaikki nämä avaimet tarkoittavat?

juuri: ./docs : tämä ominaisuus määrittää, missä dokumentit sisältävä hakemisto sijaitsee (voidaan korvata arvolla docsPath: ./docs)
rakenne:
- yhteenveto: summary.md : rekonstruoi dokumenttipuun Archbeen vasempaan navigointipaneeliin. Jos sitä ei ole, pidämme kansioita kategorioina ja jäljittelemme sisäistä tiedostorakennetta.
- resurssit: resurssit : assets-kansio on suhteellinen docsPath-polkuun. Archbee lataa kaikki kyseisestä kansiosta löytyvät tiedostot (kooditiedostot ja kuvat).
shadowDocs : teidän täytyy määrittää sisällytettävät kooditiedostot/-kansiot Varjoasiakirjat
julkaisutila : boolean-arvo, aseta arvoksi tosi , jos haluatte julkaista spacen tuotantoportaaliin jokaisen commitin jälkeen

Esimerkki archbee.yaml -konfiguraatiotiedostosta:

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

Esimerkki archbee.json -konfiguraatiotiedostosta:

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

Luo summary.md-tiedosto

Suosittelemme myös, että luotte summary.md -tiedoston. summary.md rekonstruoi dokumenttipuun Archbeen vasempaan navigointipaneeliin. Se voi myös auttaa teitä järjestämään sisältönne hyvin.

Katso alla oleva esimerkki summary.md -tiedostosta:

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

Käytä Markdown-syntaksia GitHubin kanssa

Jotkin sisältölohkot voidaan renderöidä, jos käytätte tiettyä syntaksia.

Katso Editor Markdown -pikanäppäimet käyttääksenne näitä pikanäppäimiä.

Lisää useita repositorioita

Seuratkaa näitä yksinkertaisia vaiheita lisätäksenne useita repositorioita ja synkronoidaksenne ne Archbeen kanssa:

Siirtykää Archbeehen yhdistetylle GitHub-tilillenne ja siirtykää sitten Asetukset-sivulle.

Etsikää vasemmasta sivupalkista Hakemukset.

GitHub-sovellusten sivu

Napsauttakaa Määritä -painiketta, ja kun uusi sivu avautuu, antakaa käyttöoikeus seuraaviin:

Kaikki repositoriot (tämä tarkoittaa, että voitte valita minkä tahansa repon Archbee-tililtänne)
Vain valitut repositoriot (valitkaa mikä tahansa uusi repositorio, jonka haluatte synkronoida Archbeen kanssa)
Napsauttakaa Save

Valitse repositoriot

Palatkaa takaisin Archbee-tilillenne.

Luokaa vasemmasta navigointipaneelista uusi Avaruus -> valitkaa Kirjoita GitHubissa ja valitkaa juuri lisätyt repositoriot.

Tuo Open Api -tiedostoja

Voitte tuoda Open Api -tiedostoja GitHubin kautta. Tämä ominaisuus toimii täsmälleen kuten OpenAPI:n / Swaggerin tuonti-ominaisuus, mukaan lukien sen asetukset. Määritettävänä on 2 tärkeää asiaa:

Open Api -tiedostojen (.json, .yml, .yaml) polut, jotka kirjoitetaan summary.md-määritystiedostoon
asetukset, jotka kirjoitetaan päämääritystiedostoon kohdan docTreeOptions alle:

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

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.