Configurar el repositorio

configurar el repositorio asumiendo que ya has completado la integración https //docs archbee com/github#jjpev , el siguiente paso es configurar un repositorio necesitas configurar correctamente tu repositorio para que archbee pueda obtener el contenido y organizarlo adecuadamente en nuestro sistema puedes hacer un fork de este repositorio https //github com/dragosbulugean/slate si el sistema encuentra un archivo archbee yaml en la raíz de tu repositorio u otras carpetas (en caso de que uses multipath) como este archivo yaml https //github com/dragosbulugean/slate/blob/master/ archbee yaml , entonces lo usamos para organizar el contenido presta mucha atención al archivo yaml https //github com/dragosbulugean/slate/blob/master/ archbee yaml aquí si quieres configurar la carpeta desde la que se renderiza el contenido markdown (o una jerarquía de árbol de documentos de resumen) crear archivo yaml crea un archbee yaml archivo con la siguiente estructura de variables debes colocar el archivo en la carpeta raíz de tu(s) repositorio(s) asegúrate de que el archivo permanezca allí, ya que esta es tu ruta predeterminada para otras carpetas en caso de que tengas varias carpetas, debes copiar el archivo a esas carpetas ¿cómo, preguntas? consulta cómo sincronizar múltiples carpetas https //docs archbee com/sync multiple github folders ¿qué significan todas estas claves? root /docs esta propiedad define dónde está el directorio que contiene la documentación (puede reemplazarse con docspath /docs ) structure summary summary md reconstruye el árbol del documento en el panel de navegación izquierdo en archbee si no existe, consideramos que las carpetas son las categorías e imitamos la estructura de archivos interna assets assets la carpeta de recursos es relativa a docspath archbee subirá todos los archivos encontrados en esa carpeta (archivos de código e imágenes) shadowdocs necesitas definir los archivos/carpetas de código que se incluirán como shadow docs publishspace booleano, establécelo en true si deseas publicar el espacio en el portal de producción después de cada commit ejemplo de un archbee yaml archivo de configuración archbee yaml root doc api structure summary summary md assets assets publishspace true headerincludes | \<script> document getelementbyid("demo") innerhtml = "hello javascript!"; \</script> ejemplo de un archbee json archivo de configuración archbee json { "root" "docfolderwithsummary", "structure" { "summary" "summary md", "assets" " archbee/assets" }, "customjs" "", "customcss" " \n { font family \\"comic sans ms\\", cursive, sans serif; }", "footertemplate" "", "headerincludes" "" } crear archivo summary md también recomendamos que crees un archivo summary md el summary md reconstruye el árbol del documento en el panel de navegación izquierdo en archbee y puede ayudarte a organizar tu contenido de manera adecuada consulta un ejemplo de un archivo summary md a continuación 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) usar sintaxis markdown con github algunos bloques de contenido pueden mostrarse si utilizas una sintaxis específica consulta atajos de markdown del editor docid\ idvlcwlug5 qfm2aml3ne para usar estos atajos añadir múltiples repositorios sigue estos sencillos pasos para añadir múltiples repositorios y sincronizarlos con archbee ve a tu cuenta de github https //github com/settings/installations conectada con archbee y luego navega a la página de configuración en la barra lateral izquierda, busca aplicaciones haz clic en el botón configurar y cuando se abra la nueva página, proporciona acceso a todos los repositorios (esto significa que puedes seleccionar cualquier repositorio desde tu cuenta de archbee) solo repositorios seleccionados (selecciona cualquier nuevo repositorio que quieras sincronizar con archbee) haz clic en guardar regresa a tu cuenta de archbee desde el panel de navegación izquierdo, crea un nuevo espacio > elige escribir en github y selecciona los repositorios recién añadidos importar archivos open api en realidad puedes importar archivos open api a través de github esta función funciona exactamente como la función importación de openapi / swagger docid nue3t6iliqc0v9oc rgv incluyendo su configuración hay 2 cosas importantes que configurar rutas a archivos open api ( json, yml, yaml) que deben escribirse en summary md archivo de configuración ajustes que deben escribirse en el archivo de configuración principal bajo 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 ""