mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
b0ab4fa68b
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
62 lines
2.4 KiB
Plaintext
62 lines
2.4 KiB
Plaintext
---
|
||
title: "Configuration d’un monorepo"
|
||
description: "Configurez le chemin de la documentation et le répertoire de contenu dans un projet monorepo afin que Mintlify déploie uniquement depuis votre dossier de documentation désigné."
|
||
keywords: ["monorepo", "content directory", "multi-project repository"]
|
||
---
|
||
|
||
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.
|
||
|
||
Une structure de monorepo typique pourrait ressembler à ceci :
|
||
|
||
```text
|
||
your-repo/
|
||
├── apps/
|
||
│ ├── web/
|
||
│ └── api/
|
||
├── docs/
|
||
│ ├── docs.json
|
||
│ └── quickstart.mdx
|
||
└── package.json
|
||
```
|
||
|
||
Dans cet exemple, vous définiriez le chemin de votre documentation sur `/docs`.
|
||
|
||
<div id="prerequisites">
|
||
## Prérequis
|
||
</div>
|
||
|
||
* 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.
|
||
|
||
<div id="configure-monorepo-deployment">
|
||
## Configurer le déploiement d’un monorepo
|
||
</div>
|
||
|
||
<Steps>
|
||
<Step title="Accéder aux paramètres Git">
|
||
Accédez à [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) dans votre Dashboard.
|
||
|
||
<Frame>
|
||
<img
|
||
className="block dark:hidden my-0 pointer-events-none"
|
||
src="/images/monorepo-light.png"
|
||
alt="Le panneau des paramètres du projet dans le menu Git Settings. L’option Configurer en tant que monorepo est activée et un chemin vers le répertoire /docs est renseigné."
|
||
/>
|
||
<img
|
||
className="hidden dark:block my-0 pointer-events-none"
|
||
src="/images/monorepo-dark.png"
|
||
alt="Le panneau des paramètres du projet dans le menu Git Settings. L’option Configurer en tant que monorepo est activée et un chemin vers le répertoire /docs est renseigné."
|
||
/>
|
||
</Frame>
|
||
|
||
</Step>
|
||
<Step title="Définir le chemin de votre documentation">
|
||
1. Activez l’option **Configurer en tant que monorepo**.
|
||
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`.
|
||
<Note>
|
||
N’incluez pas de barre oblique finale dans le chemin.
|
||
</Note>
|
||
3. Sélectionnez **Enregistrer les modifications**.
|
||
</Step>
|
||
</Steps> |