Configurar el repositorio

configurar el repositorio suponiendo que ya has https //docs archbee com/github#jjpev , el siguiente paso es configurar un repositorio necesitas configurar y configurar tu repositorio con éxito para que archbee pueda obtener el contenido allí y configurarlo bien de nuestro lado puedes https //github com/dragosbulugean/slate si el sistema encuentra un archbee yaml archivo en la raíz de tu repositorio u otras carpetas (en caso de que estés usando multipath) como este https //github com/dragosbulugean/slate/blob/master/ archbee yaml , entonces usamos eso para organizar el contenido presta mucha atención al https //github com/dragosbulugean/slate/blob/master/ archbee yaml aquí si deseas configurar la carpeta desde la cual se renderiza el contenido markdown (o una jerarquía de árbol de documentos 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 este es tu camino predeterminado para otras carpetas; en caso de que tengas múltiples carpetas, debes copiar el archivo a esas carpetas ¿cómo, preguntas? consulta cómo https //docs archbee com/sync multiple github folders ¿qué significan todas estas claves? raíz /docs esta propiedad define dónde está el directorio que contiene los docs (se puede reemplazar con docspath /docs ) estructura resumen summary md reconstruye el árbol de documentos en el panel de navegación izquierda en archbee si no hay ninguno, consideramos que las carpetas son las categorías y mimetizamos la estructura de archivos dentro activos assets la carpeta de activos 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 documentos sombra publishspace booleano, establece 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 summary md archivo el summary md reconstruye el árbol de documentos en el panel de navegación izquierda en archbee y puede ayudarte a organizar tu contenido de manera ordenada mira un ejemplo de un summary md archivo 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) usa la sintaxis markdown con github algunos bloques de contenido pueden ser renderizados si estás usando una sintaxis específica consulta el docid\ bzhpxzdrtx heptthvpgp para usar estos atajos agregar múltiples repositorios sigue estos simples pasos para agregar múltiples repositorios y sincronizarlos con archbee ve a tu https //github com/settings/installations cuenta conectada con archbee, y luego navega a la configuración página en la barra lateral izquierda, busca aplicaciones haz clic en el configurar botón y cuando se abra la nueva página, proporciona acceso a todos los repositorios (esto significa que puedes seleccionar cualquier repositorio de tu cuenta de archbee) solo seleccionar repositorios (selecciona cualquier nuevo repositorio que desees 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 de open api en realidad, puedes importar archivos de open api a través de github esta función funciona exactamente como docid\ ht9q0 cwyip9uno8qgsr6 función, incluyendo sus configuraciones hay 2 cosas importantes que configurar rutas a archivos open api ( json, yml, yaml) que se escribirán en summary md archivo de configuración configuraciones que se escribirán 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 ""