Mehrere GitHub-Ordner synchronisieren
Wenn Sie mehrere Ordner in Ihrem Repo haben, die Sie für Ihre Dokumente verwenden, können Sie jetzt alle mit Archbee synchronisieren.
Erinnerung, wie Sie Archbee und GitHub integrieren:
Falls Sie Ihr Gedächtnis auffrischen müssen, wie Sie die beiden integrieren, hier ist eine vollständige Anleitung dazu.
Bis jetzt konnten Sie die .archbee.yaml Datei nur in einem einzelnen Ordner und für ein einzelnes Docs-Projekt verwenden. Jetzt können Sie dies mit mehreren Ordnern tun.
Wenn Archbee eine .archbee.yaml Datei im Root des Repositories oder in einem anderen Ordner findet, verwenden wir diese, um den Inhalt zu organisieren. Es ist dieselbe Datei in allen Ordnern, in denen Sie Dokumente gespeichert haben. Hier ist ein Beispiel, wie Sie Ihr Git-Repo einrichten und konfigurieren können, damit Archbee den Inhalt daraus abrufen und sauber in unserer Software einrichten kann > Archbee git repo
Repo einrichten
Beziehen Sie sich auf unser oben genanntes Archbee-Repo.
Wenn das System eine .archbee.yaml Datei im Root des Repos findet wie dieses Beispiel, dann verwenden wir diese, um den Inhalt zu organisieren. Wenn nicht, setzen wir einfach einige Standardwerte.
Erstellen Sie eine .yaml-Datei für mehrere Ordner
Erstellen Sie eine .archbee.yaml Datei mit der folgenden Variablenstruktur.
Sie müssen die Datei im Root-Ordner Ihres Repositorys platzieren. Stellen Sie sicher, dass die Datei dort bleibt, da dies Ihr Standardpfad für alle anderen Ordner ist.
- root: ./docs 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 Navigationsbereich in Archbee. Falls keiner vorhanden ist, betrachten wir die Ordner als Kategorien und imitieren die Dateistruktur darin.
- Vermögenswerte: Vermögenswerte der assets-Ordner ist relativ zu docsPath. Archbee lädt alle Dateien hoch, die in diesem Ordner gefunden werden.
- # Dies wird alle Code-Dateien aus Ihrem Repo einschließen
- shadowDocs definiert die Code-Dateien/Ordner, die als Shadow Docs eingeschlossen werden sollen
- publishSpace boolean, setzen Sie wahr um den Space nach jedem Commit im Produktionsportal zu veröffentlichen
Unten finden Sie ein Beispiel für eine archbee.yaml Konfigurationsdatei mit dem Standard Pfad (Ordner).
root: ./docs
structure:
summary: summary.md
assets: assets
publishSpace: true
headerIncludes: |
<script>
document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script> Beispiel einer archbee.yaml Konfigurationsdatei mit Unterpfaden:
root: folderx
structure:
summary: summary.md
assets: assets
publishSpace: true
headerIncludes: |
<script>
document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script> Wenn Sie fertig sind, gehen Sie zurück zu Archbee und prüfen Sie, ob Sie im Dropdown-Menü mehrere Ordner auswählen können:
Wir empfehlen außerdem, dass Sie eine summary.md-Datei erstellen. Diese Datei rekonstruiert den Dokumentbaum im linken Navigationsbereich in Archbee. Und sie kann Ihnen helfen, Ihre Inhalte übersichtlich zu organisieren.
Sehen Sie unten ein Beispiel für eine 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)
Synchronisation in Archbee
Wenn Sie einen neuen Space erstellen und Ihr Repository auswählen, werden Änderungen automatisch in Archbee synchronisiert.
Wenn das nicht automatisch funktioniert, können Sie eine manuelle Synchronisierung durchführen, indem Sie zu Space‑Einstellungen > GitHub-Integration > navigieren und auf die Schaltfläche Mit Repository synchronisieren klicken.
