Configuration du contenu

Configurez la synchronisation Git avec des fonctionnalités supplémentaires

Si vous souhaitez configurer davantage Git Sync, vous pouvez ajouter un .gitbook.yaml fichier à la racine de votre dépôt pour indiquer à GitBook comment analyser votre dépôt Git.

.gitbook.yaml

racine : ./

​structure :
  readme : README.md
  summary : SUMMARY.md​

redirects :
  previous/page : new-folder/page.md

Racine

Le chemin de recherche de votre documentation est défini par défaut sur le répertoire racine du dépôt. Voici comment vous pouvez indiquer à GitBook de regarder dans un ./docs dossier :

.gitbook.yaml

root : ./docs/

Toutes les autres options qui spécifient des chemins seront relatives à ce dossier racine. Donc, si vous définissez root sur ./docs/ puis structure.summary comme ./product/SUMMARY.md, GitBook recherchera en réalité un fichier dans ./docs/product/SUMMARY.md.‌

​Structure‌

La structure accepte deux propriétés :‌

• readme : La première page de votre documentation. Sa valeur par défaut est ./README.md

• summary : La table des matières de votre documentation. Sa valeur par défaut est ./SUMMARY.md

La valeur de ces propriétés est un chemin vers les fichiers correspondants. Le chemin est relatif à l’option « root ». Par exemple, voici comment vous pouvez indiquer à GitBook de regarder dans un ./product dossier pour la première page et le sommaire :

.gitbook.yaml

structure :
  readme : ./product/README.md
  summary : ./product/SUMMARY.md

Lorsque Git Sync est activé, n’oubliez pas de créer ou de modifier les fichiers readme via l’interface de GitBook. Le fichier readme doit être géré exclusivement dans votre dépôt GitHub/GitLab afin d’éviter les conflits et les problèmes de duplication.

Sommaire‌

Le summary fichier est un fichier Markdown (.md) qui doit avoir la structure suivante :

./SUMMARY.md

‌# Sommaire​

## Utilisez des titres pour créer des groupes de pages comme celui-ci​

* [Titre de la première page](page1/README.md)
    * [Une page enfant](page1/page1-1.md)
    * [Une autre page enfant](part1/page1-2.md)

* [Titre de la deuxième page](page2/README.md)
    * [Une page enfant](page2/page2-1.md)
    * [Une autre page enfant](part2/page2-2.md)

## Un groupe de pages de deuxième niveau​

* [Une autre page](another-page.md)

Fournir un fichier de sommaire personnalisé est facultatif. Par défaut, GitBook recherchera un fichier nommé SUMMARY.md dans votre racine dossier si cela est spécifié dans votre fichier de configuration, ou à la racine du dépôt sinon.

Si vous ne spécifiez pas de sommaire, et que GitBook ne trouve pas de SUMMARY.md fichier à la racine de votre documentation, GitBook déduira la table des matières à partir de la structure des dossiers et des fichiers Markdown ci-dessous.‌

Le fichier Markdown du sommaire est un miroir de la table des matières de votre espace GitBook. Ainsi, même lorsqu’aucun fichier de sommaire n’est fourni lors d’une importation initiale, GitBook en créera un et/ou le mettra à jour chaque fois que vous modifierez votre contenu à l’aide de l’éditeur GitBook.

Pour cette raison, il n’est pas possible de référencer deux fois le même fichier Markdown dans votre SUMMARY.md fichier, car cela impliquerait qu’une seule page se trouve à deux URL différentes dans votre espace GitBook.

Titres de la table des matières (barre latérale)

Si vous souhaitez que vos pages aient un titre différent dans la barre latérale de la table des matières que sur la page elle-même, vous pouvez définir un titre de lien de page dans votre SUMMARY.md facultatif.

Si vous utilisez Git Sync, le titre du lien de page est défini sur le lien de page :

./SUMMARY.md

# Sommaire

* [Titre principal de la page](page.md "Titre du lien de page")

Le texte à l’intérieur des guillemets ("Titre du lien de page") sera utilisé :

• Dans la table des matières (barre latérale)

• Dans les boutons de pagination en bas de chaque page

• Dans tous les liens relatifs que vous ajoutez à cette page

Les titres de lien de page sont facultatifs — si vous n’en ajoutez pas manuellement, GitBook utilisera par défaut partout le titre standard de la page.