Repository einrichten
Repository einrichten
Wenn Sie bereits die Integration abgeschlossen haben, besteht der nächste Schritt darin, ein Repository einzurichten.
Sie müssen Ihr Repository erfolgreich einrichten und konfigurieren, damit Archbee den Inhalt darin abrufen und auf unserer Seite korrekt darstellen kann.
Sie können dieses Repository forken.
Wenn das System eine .archbee.yaml Datei im Root Ihres Repositories oder in anderen Ordnern findet (falls Sie Multipath verwenden), wie diese .yaml Datei, dann verwenden wir diese, um den Inhalt zu organisieren.
Achten Sie genau auf die .yaml Datei hier, wenn Sie den Ordner konfigurieren möchten, aus dem der Markdown-Inhalt gerendert wird (oder eine Zusammenfassungs-Dokumentbaum-Hierarchie).
Eine .yaml Datei erstellen
Erstellen Sie eine .archbee.yaml Datei mit der folgenden Variablenstruktur:
Sie müssen die Datei im Root-Ordner Ihres/ Ihrer Repositories ablegen. Stellen Sie sicher, dass die Datei dort bleibt, da dies Ihr Standardpfad für andere Ordner ist – falls Sie mehrere Ordner haben, müssen Sie die Datei in diese Ordner kopieren. Wie, fragen Sie? Prüfen Sie, wie Sie mehrere Ordner synchronisieren.
Was bedeuten all diese Keys?
- root: ./docs : Diese Eigenschaft definiert, wo sich das Verzeichnis mit den Dokumenten befindet (kann ersetzt werden durch docsPath: ./docs)
- Struktur:
- Zusammenfassung: summary.md : Rekonstruiert den Dokumentbaum im linken Navigationspanel in Archbee. Falls keiner vorhanden ist, betrachten wir die Ordner als Kategorien und ahmen die Dateistruktur darin nach.
- Vermögenswerte: Vermögenswerte : Der Assets-Ordner ist relativ zu docsPath. Archbee lädt alle Dateien aus diesem Ordner hoch (Code-Dateien und Bilder).
- shadowDocs : Sie müssen die Code-Dateien/Ordner definieren, die als Schatten-Dokumente einbezogen werden sollen
- publishSpace : Boolean, auf wahr setzen, wenn Sie den Space nach jedem Commit auf dem Produktionsportal veröffentlichen möchten
Beispiel einer archbee.yaml Konfigurationsdatei:
root: doc-api
structure:
summary: summary.md
assets: assets
publishSpace: true
headerIncludes: |
<script>
document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script> Beispiel einer archbee.json Konfigurationsdatei:
{
"root": "docfolderwithsummary",
"structure": {
"summary": "summary.md",
"assets": ".archbee/assets"
},
"customJS":"",
"customCSS":"* \n { font-family: \"Comic Sans MS\", cursive, sans-serif; }",
"footerTemplate": "",
"headerIncludes": ""
}summary.md Datei erstellen
Wir empfehlen außerdem, eine summary.md Datei zu erstellen. Die summary.md rekonstruiert den Dokumentbaum im linken Navigationspanel in Archbee. Damit können Sie Ihren Inhalt übersichtlich organisieren.
Unten sehen Sie ein Beispiel einer summary.md Datei:
- [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)
Markdown-Syntax mit GitHub verwenden
Einige Inhaltsblöcke können gerendert werden, wenn Sie eine spezifische Syntax verwenden.
Sehen Sie sich die Editor Markdown Tastenkombinationen an, um diese Tastenkombinationen zu verwenden.
Mehrere Repositories hinzufügen
Folgen Sie diesen einfachen Schritten, um mehrere Repositories hinzuzufügen und mit Archbee zu synchronisieren:
Gehen Sie zu Ihrem GitHub-Konto, das mit Archbee verbunden ist, und navigieren Sie dann zur Einstellungen-Seite.
Suchen Sie in der linken Seitenleiste nach Anwendungen.
Klicken Sie auf die Schaltfläche Konfigurieren und wenn die neue Seite geöffnet wird, gewähren Sie Zugriff auf:
- Alle Repositories (das bedeutet, dass Sie jedes Repository aus Ihrem Archbee-Konto auswählen können)
- Nur ausgewählte Repositories (wählen Sie jedes neue Repository aus, das Sie mit Archbee synchronisieren möchten)
- Klicken Sie auf Speichern
Gehen Sie zurück zu Ihrem Archbee-Konto.
Erstellen Sie im linken Navigationsbereich einen neuen Weltraum → wählen Sie In GitHub schreiben und wählen Sie die neu hinzugefügten Repositories aus.
Open Api-Dateien importieren
Sie können Open Api-Dateien über GitHub importieren. Diese Funktion funktioniert genauso wie die Importieren von OpenAPI / Swagger-Funktion, einschließlich ihrer Einstellungen. Es gibt 2 wichtige Dinge, die eingerichtet werden müssen:
- Pfade zu Open Api-Dateien (.json, .yml, .yaml), die in die summary.md-Konfigurationsdatei eingetragen werden müssen
- Einstellungen, die in die Hauptkonfigurationsdatei unter docTreeOptions eingetragen werden müssen:
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: ""