Configuration du contenu

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

Si vous souhaitez configurer Git Sync davantage, 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

root: ./

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

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

Racine

Le chemin de recherche de votre documentation pointe par défaut vers le répertoire racine du dépôt. Voici comment 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 comme ./docs/ et ensuite structure.summary en tant que ./product/SUMMARY.md, GitBook recherchera en fait 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 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 ne pas créer ou modifier les fichiers readme via l'interface de GitBook. Le fichier readme doit être géré exclusivement dans votre dépôt GitHub/GitLab pour é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

‌# Summary​

## 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 deuxième groupe de pages​

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

Fournir un fichier de sommaire personnalisé est optionnel. Par défaut, GitBook recherchera un fichier nommé SUMMARY.md dans votre root dossier si 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 vos docs, 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 du 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 mettrez à jour votre contenu à l'aide de l'éditeur GitBook.

À cause de cela, 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 existe à deux URL différentes dans votre espace GitBook.

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

Si vous voulez 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 fichier.

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

./SUMMARY.md

# Summary

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

Le texte entre guillemets ("Titre de lien de la 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 le titre standard de la page partout.

​Redirections

Les redirections vous permettent de définir des redirections dans votre .gitbook.yaml fichier de configuration. Le chemin est relatif à l'option « root ». Par exemple, voici comment indiquer à GitBook de rediriger les utilisateurs accédant à une URL précédente /help vers une nouvelle URL /support

.gitbook.yaml

root: ./

redirects :
  help: support.md

Les redirections que vous définissez dans le fichier de configuration d'un espace sont limitées à l'espace correspondant. Nous recommandons de créer redirections de site dans la plupart des cas car elles s'appliquent à tout le site, à travers les espaces.

Avec Git, lorsqu'un fichier est déplacé plusieurs fois, le fichier est supprimé et un nouveau est créé. Cela rend impossible pour GitBook de savoir qu'un dossier a été renommé, par exemple. Assurez-vous de vérifier attentivement et d'ajouter des redirections lorsque c'est nécessaire.