---
title: Configurar el repositorio
slug: configurar-el-repositorio
description: Aprende cómo configurar un repositorio para Archbee, una plataforma de colaboración de documentación, con esta guía paso a paso. Crea un archivo `.archbee.yaml` con estructuras de variables y explora ejemplos de archivos de configuración `.yaml` y `.json`
createdAt: 2023-01-18T13:04:58.000Z
---

## 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.

:::hint{type="info"}
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.

:::hint{type="warning"}
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:

:::hint{type="danger"}
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`    &#x20;: 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:

:::CodeblockTabs
archbee.yaml

```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:

:::CodeblockTabs
archbee.json

```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:

:::CodeblockTabs
summary.md

```markdown
- [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:

::::WorkflowBlock
:::WorkflowBlockItem
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.**

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/HChEov2q-7IXyJVa81Mbj_github-appconfigure-light.png "Página de aplicaciones de GitHub")
:::

:::WorkflowBlockItem
Haz clic en el botón **Configurar&#x20;**&#x79; cuando se abra la nueva página, proporciona acceso a:

1. *Todos los repositorios* (esto significa que puedes seleccionar cualquier repositorio desde tu cuenta de Archbee)
2. *Solo repositorios seleccionados* (selecciona cualquier nuevo repositorio que quieras sincronizar con Archbee)
3. Haz clic en Guardar



![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/zspijTRLT875JPad9Cecf_image.png "Seleccionar repositorios")
:::

:::WorkflowBlockItem
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`:

:::CodeblockTabs
.archbee.yaml

```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: ""

```
:::

