Repository einrichten

repository einrichten wenn sie bereits die integration abgeschlossen haben https //docs archbee com/github#jjpev , 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 https //github com/dragosbulugean/slate wenn das system eine archbee yaml datei im root ihres repositories oder in anderen ordnern findet (falls sie multipath verwenden), wie diese yaml datei https //github com/dragosbulugean/slate/blob/master/ archbee yaml , dann verwenden wir diese, um den inhalt zu organisieren achten sie genau auf die yaml datei https //github com/dragosbulugean/slate/blob/master/ archbee yaml 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 https //docs archbee com/sync multiple github folders 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 archbee yaml 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 archbee json { "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 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) 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 docid\ yqdxdtor4krgqm grsm9e 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 https //github com/settings/installations 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 docid 9sei5xd0cgbklv31noblg 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 archbee 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 ""