Sincronizar múltiples carpetas de GitHub
Si tienes múltiples carpetas en tu repositorio que usas para tu documentación, ahora puedes sincronizarlas todas con Archbee.
Recordatorio sobre cómo integrar Archbee y GitHub:
En caso de que necesites refrescar la memoria sobre cómo integrar ambos, aquí tienes una guía completa al respecto.
Hasta ahora, solo podías usar el archivo .archbee.yaml en una carpeta única y para un único proyecto de documentación. Ahora puedes hacerlo con múltiples carpetas.
Si Archbee encuentra un archivo .archbee.yaml en la raíz del repositorio o en cualquier otra carpeta, usamos ese archivo para organizar el contenido. Es el mismo archivo en todas las carpetas donde tengas documentación almacenada. Aquí tienes un ejemplo de cómo configurar tu repositorio Git para que Archbee pueda obtener el contenido y organizarlo adecuadamente en nuestro software > Repositorio de Archbee en Git
Configurar el repositorio
Consulta nuestro repositorio de Archbee mencionado anteriormente.
Si el sistema encuentra un archivo .archbee.yaml en la raíz del repositorio como este, entonces lo usamos para organizar el contenido. Si no, simplemente estableceremos algunos valores predeterminados.
Crear archivo .yaml para múltiples carpetas
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 todas las demás carpetas.
- root: ./docs define la propiedad donde 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 cargará todos los archivos encontrados en esa carpeta.
- # Esto incluirá todos los archivos de código de tu repositorio
- shadowDocs define los archivos/carpetas de código que se incluirán como Shadow Docs
- publishSpace booleano, establece true para publicar el espacio en el portal de producción después de cada commit
A continuación se muestra un ejemplo de un archbee.yaml archivo de configuración con la ruta predeterminada (carpeta).
root: ./docs
structure:
summary: summary.md
assets: assets
publishSpace: true
headerIncludes: |
<script>
document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script> Ejemplo de archbee.yaml archivo de configuración con subrutas:
root: folderx
structure:
summary: summary.md
assets: assets
publishSpace: true
headerIncludes: |
<script>
document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script> Cuando hayas terminado, vuelve a Archbee y comprueba si puedes seleccionar varias carpetas en el menú desplegable:
También recomendamos que crees un archivo summary.md . Este archivo reconstruye el árbol de documentos en el panel de navegación izquierdo en Archbee. Y puede ayudarte a organizar bien tu contenido.
Consulta un ejemplo de un archivo summary.md a continuación:
- [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)
Sincronizar en Archbee
Cuando creas un nuevo espacio y seleccionas tu repositorio, los cambios se sincronizan automáticamente en Archbee.
Si eso no funciona automáticamente, puedes forzar la sincronización navegando a Configuración del espacio > Integración con GitHub > haz clic en el botón Sincronizar con el repositorio.
