Passer au contenu principal
Les déploiements multi-référentiels sont disponibles avec les plans Enterprise.
Utilisez un déploiement multi-référentiels lorsqu’un même site doit regrouper du contenu provenant de plusieurs référentiels Git. Lorsque vous configurez plusieurs référentiels comme sources d’un même projet Mintlify, le contenu de chaque référentiel dispose de son propre chemin d’URL. Par exemple, vous pouvez combiner des référentiels distincts pour la documentation produit, la référence d’API et les guides SDK au sein d’un même site : 
docs.example.com/product
docs.example.com/api
docs.example.com/sdks

​
Fonctionnement des déploiements multi-référentiels

Chaque référentiel d’un déploiement multi-référentiels possède :
  • Sa propre connexion à un fournisseur Git
  • Sa propre branche
  • Un répertoire de contenu facultatif
  • Son propre chemin d’URL
  • Son propre docs.json
Lors du déploiement, Mintlify lit chaque référentiel et combine les sources configurées en un seul site. Chaque source apparaît sous son chemin d’URL configuré. Le docs.json du premier référentiel configuré sert de docs.json racine du déploiement. Sa configuration au niveau du site contrôle le site combiné, y compris les paramètres tels que le thème, les couleurs, le logo, les intégrations, le SEO et les autres champs de premier niveau. Les autres sources fournissent leur navigation et leur contenu sous leurs chemins d’URL respectifs.
Les déploiements multi-référentiels sont différents d’une configuration monorepo. Utilisez une configuration monorepo lorsque vous stockez tout le contenu dans un sous-répertoire à côté du code source d’un même référentiel. Utilisez les déploiements multi-référentiels lorsque vous stockez le contenu dans des référentiels distincts.

​
Prérequis

  • Un plan Enterprise
  • Un accès administrateur à votre projet Mintlify
  • Un fichier docs.json dans chaque référentiel source
  • Toutes les sources doivent utiliser le même fournisseur Git (tout GitHub ou tout GitLab). L’ajout d’une source d’un autre fournisseur supprime toutes les sources existantes de l’autre type
Les chemins d’URL doivent être uniques et ne peuvent pas se chevaucher. Par exemple, ne configurez pas une source sur /docs et une autre sur /docs/api.

​
Configurer plusieurs référentiels

1

Ouvrir les paramètres Git

Accédez aux paramètres Git dans votre tableau de bord.
La page des paramètres Git dans le tableau de bord Mintlify. Le bouton Ajouter un référentiel est visible en bas.
2

Ajouter un autre référentiel

Cliquez sur Add repository.
3

Configurer la source du référentiel

Sélectionnez le référentiel, la branche et tous les champs requis spécifiques au fournisseur Git (GitHub ou GitLab).
Le panneau de configuration du référentiel sur la page des paramètres Git. Le référentiel, la branche et les champs spécifiques à GitHub sont visibles.
Pour les sources GitHub, l’application GitHub de Mintlify doit avoir accès au référentiel. Pour les sources GitLab, fournissez l’ID du projet et un jeton de déploiement avec la portée read_repository.Si le docs.json du référentiel se trouve dans un sous-répertoire plutôt qu’à la racine, activez docs.json is in a subdirectory et saisissez le chemin vers ce répertoire.
4

Définir le chemin d’URL

Saisissez un URL path pour la source du référentiel.Le chemin d’URL détermine l’emplacement où le contenu de ce référentiel apparaît sur votre site de documentation. Par exemple, un chemin d’URL api diffuse le contenu sous docs.example.com/api.
Vous pouvez saisir le chemin avec ou sans barre oblique de tête. Mintlify normalise la valeur lors de l’enregistrement.
5

Enregistrer les modifications

Cliquez sur Save changes. Mintlify enregistre la configuration et met en file d’attente un déploiement du site combiné.

​
Exemple d’organisation des référentiels

Dans cet exemple, chaque source dispose de son propre référentiel et de son propre 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/
Configurez chaque référentiel avec un chemin d’URL :
RéférentielChemin d’URLChemin publié
acme/product-docsproduct/product
acme/api-docsapi/api
acme/sdk-docssdks/sdks
Mintlify combine la navigation de chaque référentiel en une seule navigation de site. Chaque source de référentiel devient une section produit de premier niveau sous le chemin d’URL configuré. Le nom de chaque section produit provient du champ name du docs.json du référentiel correspondant. Par exemple, si le docs.json d’un référentiel définit "name": "API Reference", sa section produit apparaît comme « API Reference » dans la navigation combinée. Conservez une navigation cantonnée à chaque source. Par exemple, les pages du référentiel API ne doivent référencer que des fichiers qui se trouvent dans le référentiel API, et les pages du référentiel SDK ne doivent référencer que des fichiers qui se trouvent dans le référentiel SDK. Les configurations imbriquées navigation.products ne sont pas prises en charge à l’intérieur des référentiels sources individuels.

​
Supprimer une source de référentiel

Vous pouvez supprimer une source de référentiel depuis la page des paramètres Git de votre tableau de bord. Lorsqu’il ne reste plus qu’une seule source de référentiel, Mintlify supprime le chemin d’URL de la source et traite le référentiel restant comme la source racine du déploiement.

Sujets connexes

DéploiementsAutorisations de déploiementAperçus de déploiement