Saltar al contenido principal
Las implementaciones multi-repositorio están disponibles en los planes Enterprise.
Usa una implementación multi-repositorio cuando un sitio necesite contenido de más de un repositorio de Git. Cuando configuras varios repositorios como fuentes del mismo proyecto de Mintlify, el contenido de cada repositorio tiene su propia ruta de URL. Por ejemplo, puedes combinar repositorios separados de documentación de producto, referencia de API y guías de SDK en un único sitio: 
docs.example.com/product
docs.example.com/api
docs.example.com/sdks

​
Cómo funcionan las implementaciones multi-repositorio

Cada repositorio en una implementación multi-repositorio tiene su propio:
  • Conexión con el proveedor de Git
  • Rama
  • Directorio de contenido opcional
  • Ruta de URL
  • docs.json
Durante la implementación, Mintlify lee cada repositorio y combina las fuentes configuradas en un único sitio. Cada fuente aparece bajo su ruta de URL configurada. El docs.json del primer repositorio configurado es el docs.json raíz de la implementación. Su configuración a nivel de sitio controla el sitio combinado, incluyendo opciones como el tema, los colores, el logotipo, las integraciones, el SEO y otros campos de nivel superior. Las demás fuentes aportan su navegación y contenido bajo sus rutas de URL configuradas.
Las implementaciones multi-repositorio son distintas a una configuración de monorepo. Usa una configuración de monorepo cuando almacenes todo el contenido en un subdirectorio junto con el código fuente en un único repositorio. Usa implementaciones multi-repositorio cuando almacenes el contenido en repositorios distintos.

​
Requisitos

  • Un plan Enterprise
  • Acceso de administrador a tu proyecto de Mintlify
  • Un archivo docs.json en cada repositorio de origen
  • Todas las fuentes de repositorio deben usar el mismo proveedor de Git (todas GitHub o todas GitLab). Añadir una fuente de un proveedor distinto elimina todas las fuentes existentes del otro tipo
Las rutas de URL deben ser únicas y no pueden superponerse. Por ejemplo, no configures una fuente en /docs y otra fuente en /docs/api.

​
Configurar varios repositorios

1

Abrir la configuración de Git

Ve a la configuración de Git en tu panel.
La página de configuración de Git en el panel de Mintlify. El botón Add repository está visible en la parte inferior.
2

Añadir otro repositorio

Haz clic en Add repository.
3

Configurar la fuente del repositorio

Selecciona el repositorio, la rama y los campos específicos del proveedor de Git que se requieran (GitHub o GitLab).
El panel de configuración del repositorio en la página de configuración de Git. El repositorio, la rama y los campos específicos de GitHub están visibles.
Para fuentes de GitHub, la aplicación de GitHub de Mintlify debe tener acceso al repositorio. Para fuentes de GitLab, proporciona el ID del proyecto y un token de despliegue con el alcance read_repository.Si el docs.json del repositorio se encuentra en un subdirectorio en lugar de en la raíz, habilita docs.json is in a subdirectory e introduce la ruta a ese directorio.
4

Establecer la ruta de URL

Introduce una URL path para la fuente del repositorio.La ruta de URL determina dónde aparece el contenido de ese repositorio en tu sitio de documentación. Por ejemplo, una ruta de URL api sirve el contenido bajo docs.example.com/api.
Puedes introducir la ruta con o sin barras iniciales. Mintlify normaliza el valor al guardar.
5

Guardar los cambios

Haz clic en Save changes. Mintlify guarda la configuración y pone en cola un despliegue del sitio combinado.

​
Ejemplo de organización de repositorios

En este ejemplo, cada fuente tiene su propio repositorio y su propio docs.json. 
acme/product-docs
├── docs.json
├── overview.mdx
└── guides/

acme/api-docs
├── docs.json
├── introduction.mdx
└── reference/

acme/sdk-docs
├── docs.json
├── quickstart.mdx
└── javascript/
Configura cada repositorio con una ruta de URL:
RepositorioRuta de URLRuta publicada
acme/product-docsproduct/product
acme/api-docsapi/api
acme/sdk-docssdks/sdks
Mintlify combina la navegación de cada repositorio en una única navegación del sitio. Cada fuente de repositorio se convierte en una sección de producto de nivel superior bajo la ruta de URL configurada. El nombre de cada sección de producto proviene del campo name en el docs.json del repositorio correspondiente. Por ejemplo, si el docs.json de un repositorio establece "name": "API Reference", su sección de producto aparece como “API Reference” en la navegación combinada. Mantén la navegación de cada fuente acotada a ese repositorio. Por ejemplo, las páginas en el repositorio de API deben referenciar solo archivos que estén en el repositorio de API, y las páginas en el repositorio de SDK deben referenciar solo archivos que estén en el repositorio de SDK. Las configuraciones anidadas de navigation.products no son compatibles dentro de los repositorios de origen individuales.

​
Eliminar una fuente de repositorio

Puedes eliminar una fuente de repositorio desde la página de configuración de Git en tu panel. Cuando solo queda una fuente de repositorio, Mintlify elimina la ruta de URL de la fuente y trata el repositorio restante como la fuente raíz de la implementación.

Temas relacionados

ImplementacionesImplementaciones de vista previaCrear documentación para desarrolladores