Skip to main content
Configurez Mintlify pour déployer la documentation depuis un répertoire spécifique au sein d’un monorepo. Cette configuration vous permet de conserver la documentation aux côtés de votre code dans des référentiels contenant plusieurs projets ou services.
Un déploiement monorepo utilise un seul dépôt avec un sous-répertoire de docs. Pour combiner le contenu de plusieurs dépôts dans un seul site, consultez Déploiements multi-référentiels.
Une structure de monorepo typique pourrait ressembler à ceci :
Dans cet exemple, vous définiriez le chemin de votre documentation sur /docs.

Prérequis

  • Accès administrateur à votre projet Mintlify.
  • Fichiers de documentation organisés dans un répertoire dédié au sein de votre monorepo.
  • Un fichier docs.json valide dans votre répertoire de documentation.

Configurer le déploiement d’un monorepo

1

Accéder aux paramètres Git

Accédez à Git Settings dans votre Dashboard.
Le panneau des paramètres du projet dans le menu Git Settings, avec l’option docs.json is in a subdirectory activée et un chemin vers le répertoire /docs renseigné.
2

Définir le chemin de votre documentation

  1. Activez l’option docs.json is in a subdirectory.
  2. Saisissez le chemin relatif vers votre répertoire de documentation. Par exemple, si votre documentation se trouve dans le répertoire docs, saisissez /docs.
N’incluez pas de barre oblique finale dans le chemin.
  1. Sélectionnez Enregistrer les modifications. L’enregistrement déclenche un nouveau déploiement à partir du chemin configuré.