Monorepos

Utilisez Git Sync avec des monorepos et mappez les espaces vers des répertoires séparés

Utilisez Git Sync à l’échelle du site pour synchroniser plusieurs espaces à partir d’un seul dépôt et d’une seule branche. Associez chaque espace à son propre répertoire dans gitbook-docs.yaml.

Comment fonctionne Git Sync à l’échelle du site

Du site Répertoire du projet définit le répertoire d’installation de Git Sync. gitbook-docs.yaml se trouve là. Si vous le laissez vide, GitBook utilise la racine du dépôt.

Dans gitbook-docs.yaml, chaque espace a un content.directoryles fichiers de l’espace .gitbook.yaml, README.md, SUMMARY.mdet les fichiers de contenu.

Pour un aperçu de ces fichiers, voir Configuration du contenu.

Associer les espaces aux répertoires

Utilisez Mappage du contenu dans le panneau Git Sync pour associer chaque espace. GitBook enregistre l’association dans gitbook-docs.yaml.

Le fonctionnement des chemins d’accès est le suivant :

Chemin	Signification
./docs	Un répertoire à l’intérieur du répertoire Projet du site.
/docs	Un répertoire à partir de la racine du dépôt.
docs	Identique à ./docs.

Par exemple, ce dépôt associe trois espaces :

/
  gitbook-docs.yaml
  documentation/
    .gitbook.yaml
    README.md
    SUMMARY.md
    .gitbook/
      assets/
        logo.png
  developers/
    .gitbook.yaml
    README.md
    SUMMARY.md
  changelog/
    .gitbook.yaml
    README.md
    SUMMARY.md

Ce gitbook-docs.yaml associe chaque espace à son répertoire :

gitbook-docs.yaml

$schema: https://api.gitbook.com/gitbook-docs.yaml
site:
  structure:
    - type: space
      key: documentation
      title: Documentation
      path: documentation
      content:
        répertoire : ./documentation
    - type: space
      clé : developers
      titre : Developers
      chemin : developers
      content:
        répertoire : ./developers
    - type: space
      clé : changelog
      titre : Changelog
      chemin : changelog
      content:
        répertoire : ./changelog

Conservez le contenu de l’espace autonome

Chaque espace ne synchronise que le répertoire qui lui est attribué. GitBook ne partage pas automatiquement le contenu ni les ressources entre les répertoires mappés.

Conservez chaque ressource référencée à l’intérieur du répertoire mappé de son espace. Si plusieurs espaces ont besoin d’une ressource, ajoutez-en une copie dans chaque répertoire ou réorganisez le dépôt.

directement — passez chaque réponse dans .gitbook.yaml root Ce paramètre contrôle l’endroit où GitBook lit le contenu dans le répertoire mappé de cet espace. Il n’expose pas les répertoires frères.

Déplacer un répertoire mappé

Déplacez le contenu d’un espace en mettant à jour ensemble ses fichiers et son mappage :

1. Dans le dépôt, déplacez les fichiers de contenu et les ressources de l’espace.
2. Dans gitbook-docs.yaml, mettez à jour le content.directory. Conservez son clé inchangé.
3. Validez les deux changements dans le même commit.

Si GitBook importe avant que les deux changements n’existent, l’espace mappé peut apparaître vide.

Ne renommez pas le clé pour l’adapter au nouveau répertoire. Les clés et les noms de répertoire sont indépendants. Modifier la clé d’un espace remplace l’espace par un nouvel espace doté d’un nouvel identifiant d’espace, et restaurer la clé d’origine ne rétablit pas l’ancien identifiant. Voir Les clés identifient vos espaces.

Clés générées par GitBook — space-1, space-2 — ne reflètent pas les noms de répertoire, et il n’y a aucun avantage à les aligner.

Utiliser Git Sync pour un espace individuel

Utilisez Git Sync pour un espace individuel lorsqu’un espace a besoin d’un autre dépôt ou d’une autre branche. Par exemple, utilisez-le lorsqu’un espace privé doit se synchroniser séparément.

Retirez d’abord l’espace du mappage de contenu du site. Configurez ensuite Git Sync à partir de cet espace.

Pour configurer l’espace, suivez Activation de la synchronisation GitHub ou Activation de la synchronisation GitLab. À l’étape de portée, sélectionnez Git Sync de l’espace.