Configurer le dépôt

configurer le dépôt en supposant que vous avez déjà https //docs archbee com/github#jjpev , la prochaine étape consiste à configurer un dépôt vous devez configurer et configurer votre dépôt avec succès afin qu'archbee puisse récupérer le contenu et le configurer correctement de notre côté vous pouvez https //github com/dragosbulugean/slate si le système trouve un archbee yaml fichier à la racine de votre dépôt ou dans d'autres dossiers (au cas où vous utilisez multipath) comme ceci https //github com/dragosbulugean/slate/blob/master/ archbee yaml , alors nous l'utilisons pour organiser le contenu faites attention au https //github com/dragosbulugean/slate/blob/master/ archbee yaml ici si vous souhaitez configurer le dossier à partir duquel le contenu markdown est rendu (ou une hiérarchie de document sommaire) créer un fichier yaml créer un archbee yaml fichier avec la structure de variables suivante vous devez placer le fichier dans le dossier racine de votre ou vos dépôts assurez vous que le fichier y reste car c'est votre chemin par défaut pour d'autres dossiers dans le cas où vous avez plusieurs dossiers, vous devez copier le fichier dans ces dossiers comment, demandez vous ? vérifiez comment https //docs archbee com/sync multiple github folders que signifient toutes ces clés ? racine /docs cette propriété définit où se trouve le répertoire contenant les docs (peut être remplacé par docspath /docs ) structure résumé summary md reconstruit l'arborescence du document dans le panneau de navigation à gauche dans archbee s'il n'y en a pas, nous considérons que les dossiers sont les catégories et imitent la structure des fichiers à l'intérieur ressources assets le dossier des ressources est relatif à docspath archbee téléchargera tous les fichiers trouvés dans ce dossier (fichiers de code et images) shadowdocs vous devez définir les fichiers/dossiers de code à inclure comme documents ombres publishspace booléen, défini sur vrai si vous souhaitez publier l'espace sur le portail de production après chaque commit exemple d'un archbee yaml fichier de configuration archbee yaml root doc api structure summary summary md assets assets publishspace true headerincludes | \<script> document getelementbyid("demo") innerhtml = "hello javascript!"; \</script> exemple d'un archbee json fichier de configuration archbee json { "root" "docfolderwithsummary", "structure" { "summary" "summary md", "assets" " archbee/assets" }, "customjs" "", "customcss" " \n { font family \\"comic sans ms\\", cursive, sans serif; }", "footertemplate" "", "headerincludes" "" } créer un fichier summary md nous vous recommandons également de créer un summary md fichier le summary md reconstruit l'arborescence du document dans le panneau de navigation à gauche dans archbee et cela peut vous aider à organiser votre contenu de manière agréable voir un exemple de fichier summary md ci dessous 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) utiliser la syntaxe markdown avec github certains blocs de contenu peuvent être rendus si vous utilisez une syntaxe spécifique vérifiez les docid 9rx1c40z zqywjtrf0 9n pour utiliser ces raccourcis ajouter plusieurs dépôts suivez ces étapes simples pour ajouter plusieurs dépôts et les synchroniser avec archbee allez sur votre https //github com/settings/installations compte connecté avec archbee, puis naviguez vers la page des paramètres dans la barre latérale gauche, recherchez applications cliquez sur le configurer bouton et lorsque la nouvelle page s'ouvre, accordez l'accès à tous les dépôts (cela signifie que vous pouvez sélectionner n'importe quel dépôt de votre compte archbee) sélectionner uniquement des dépôts (sélectionnez tout nouveau dépôt que vous souhaitez synchroniser avec archbee) cliquez sur enregistrer retournez à votre compte archbee dans le panneau de navigation gauche, créez un nouveau espace > choisissez écrire dans github et sélectionnez les dépôts nouvellement ajoutés importer des fichiers open api vous pouvez en fait importer des fichiers open api via github cette fonctionnalité fonctionne exactement comme docid\ slgor2sjxtq6 jcf1izkj fonctionnalité, y compris ses paramètres il y a 2 choses importantes à configurer chemins vers les fichiers open api ( json, yml, yaml) à écrire dans summary md fichier de configuration paramètres à écrire dans le fichier de configuration principal sous doctreeoptions 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 ""