Das Repository einrichten

repository einrichten angenommen, sie haben bereits die integration abgeschlossen https //docs archbee com/github#jjpev , ist der nächste schritt das einrichten eines repositories sie müssen ihr repository erfolgreich einrichten und konfigurieren, damit archbee den inhalt daraus abrufen und auf unserer seite sauber einrichten 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 nutzen 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 zusammenfassende dokumentbaumhierarchie) erstellen der yaml datei erstellen sie eine archbee yaml datei mit der folgenden variablenstruktur sie müssen die datei im stammordner ihres repository bzw 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 sich? sehen sie nach, wie sie mehrere ordner synchronisieren https //docs archbee com/sync multiple github folders was bedeuten all diese schlüssel? root /docs diese eigenschaft definiert, wo sich das verzeichnis mit den dokumenten befindet (kann ersetzt werden durch docspath /docs ) structure summary summary md rekonstruiert den dokumentenbaum im linken navigationsbereich in archbee falls keiner vorhanden ist, betrachten wir die ordner als kategorien und bilden die dateistruktur darin nach assets assets der assets ordner ist relativ zu docspath archbee lädt alle dateien hoch, die in diesem ordner gefunden werden (code dateien und bilder) shadowdocs sie müssen die code dateien/ordner definieren, die als shadow dokumente publishspace boolean, auf true 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 für eine 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" "" } erstelle summary md datei wir empfehlen außerdem, dass du eine summary md datei erstellst die summary md rekonstruiert den dokumentenbaum im linken navigationsbereich in archbee und sie kann dir helfen, deine inhalte übersichtlich zu organisieren siehe ein beispiel einer summary md datei unten 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 du eine spezifische syntax verwendest sieh dir die editor markdown verknüpfungen docid\ yqdxdtor4krgqm grsm9e an, um diese verknüpfungen zu verwenden mehrere repositories hinzufügen befolge diese einfachen schritte, um mehrere repositories hinzuzufügen und sie mit archbee zu synchronisieren gehe zu deinem github https //github com/settings/installations konto, das mit archbee verbunden ist, und navigiere dann zur einstellungs seite suche in der linken seitenleiste nach anwendungen klicke auf die schaltfläche konfigurieren und wenn die neue seite geöffnet wird, gewähre zugriff auf alle repositories (das bedeutet, dass du jedes repository aus deinem archbee konto auswählen kannst) nur ausgewählte repositories (wähle jedes neue repository aus, das du mit archbee synchronisieren möchtest) klicke auf speichern gehe zurück zu deinem archbee konto erstelle im linken navigationsbereich einen neuen space > wähle write in github und wähle die neu hinzugefügten repositories aus open api dateien importieren sie können open api dateien tatsächlich über github importieren diese funktion funktioniert genauso wie importieren von openapi / swagger docid 9sei5xd0cgbklv31noblg funktion, einschließlich ihrer einstellungen es gibt zwei wichtige dinge, die eingerichtet werden müssen pfade zu open api dateien ( json, yml, yaml), die in summary md konfigurationsdatei geschrieben werden sollen einstellungen, die in die hauptkonfigurationsdatei unter doctreeoptions geschrieben werden sollen 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 ""