Contenu réutilisable

Créez des blocs de contenu réutilisables pouvant être utilisés dans plusieurs espaces, et tous mis à jour en même temps lorsque vous modifiez une instance

Le contenu réutilisable vous permet de synchroniser le contenu entre plusieurs pages et espaces, afin que vous puissiez modifier toutes les occurrences du bloc en même temps.

Créez du contenu réutilisable dans un espace.

Notions fondamentales

Le contenu réutilisable fonctionne comme n’importe quel autre contenu : vous pouvez le modifier via des demandes de changement, l’inclure dans des workflows de relecture, et il s’affichera correctement sur n’importe quel site publié.

Bien que le contenu réutilisable puisse être référencé dans plusieurs espaces, il appartient à un seul espace parent.

Le concept d’« espace parent »

L’espace parent est l’espace qui possède le contenu réutilisable. C’est le seul endroit où ce contenu peut être modifié.

Même si les mises à jour du contenu réutilisable apparaîtront instantanément dans toutes les occurrences, toutes les modifications doivent provenir de l’espace parent — soit sous la forme d’une modification directe, soit via une demande de changement.

Les espaces sont un concept central dans GitBook, prenant en charge à la fois les workflows éditoriaux et la sécurité. Comme GitBook applique une édition basée sur les autorisations, le contenu réutilisable ne peut être modifié que depuis son espace parent. Cela garantit le respect des droits de modification, même lorsque le contenu est réutilisé dans toute l’organisation.

Limitations connues

Intégrations

Les blocs fournis par des intégrations ne sont pas pris en charge dans le contenu réutilisable. En effet, les intégrations dans GitBook sont installées par espace, et la limitation de l’accès garantit que les intégrations tierces n’ont que les autorisations que vous leur accordez. Référencer du contenu réutilisable entre espaces briserait cette frontière de sécurité.

Recherche

Actuellement, le contenu réutilisable n’apparaît dans les résultats de recherche que dans son espace parent. Nous travaillons activement à supprimer cette limitation afin que le contenu réutilisable apparaisse dans les résultats de recherche partout où il est référencé.

Dans l’application

Créer du contenu réutilisable

Pour créer du contenu réutilisable, sélectionnez un ou plusieurs blocs, puis ouvrez le menu d’actions , sélectionnez Transformer en, puis choisissez Contenu réutilisable. Vous pouvez aussi donner un nom à votre bloc pour le retrouver et le réutiliser plus facilement plus tard.

Sinon, vous pouvez sélectionner un ou plusieurs blocs, puis appuyer sur Cmd + C pour ouvrir une invite vous demandant si vous souhaitez créer du contenu réutilisable.

Insérer du contenu réutilisable

Vous pouvez insérer du contenu réutilisable comme n’importe quel autre bloc. Appuyez sur / sur une ligne vide pour ouvrir la palette d’insertion et recherchez votre contenu par son nom ou simplement en cherchant « réutilisable ». Sinon, cliquez sur le + à gauche de n’importe quel bloc ou ligne vide.

Vous trouverez également le panneau de contenu réutilisable dans la barre latérale des pages, où vous pouvez consulter une liste des blocs de contenu créés précédemment dans votre espace actuel.

Modifier le contenu réutilisable

Le contenu réutilisable est comme n’importe quel autre contenu — vous pouvez modifier directement n’importe quelle occurrence si modifications en direct sont activées, ou via une demande de changement sinon. Toutes les modifications que vous apportez seront synchronisées partout où le contenu est utilisé.

Si vous effectuez des modifications dans une demande de changement, le contenu sera synchronisé avec toutes les autres occurrences une fois cette demande de changement fusionnée.

Détacher le contenu réutilisable

Vous pouvez détacher le contenu réutilisable en ouvrant le menu d’actions et en sélectionnant Détacher. Le détachement convertira le contenu en blocs ordinaires.

Une fois détaché, toutes les modifications que vous apportez au(x) bloc(s) ne seront pas répercutées dans les autres occurrences, et les modifications que vous apportez dans ces occurrences ne seront pas répercutées dans le(s) bloc(s) détaché(s). Toutes les autres occurrences du contenu réutilisable restent synchronisées entre elles.

Supprimer le contenu réutilisable

Vous pouvez supprimer complètement le contenu réutilisable de votre espace, si vous le souhaitez. Trouvez le contenu réutilisable dans la table des matières de la page, puis ouvrez le menu d’actions à côté du contenu que vous souhaitez supprimer, et sélectionnez Supprimer.

La suppression du contenu réutilisable va le supprimer de toutes les pages où il est utilisé. Cette action est irréversible.

Synchronisation avec GitHub et GitLab

Le contenu réutilisable est entièrement pris en charge lors de la synchronisation vers GitHub et GitLab. Votre contenu réutilisable sera exporté dans un dossier dédié inclut chaque contenu étant un fichier Markdown distinct.

Votre contenu est ensuite référencé dans vos autres pages à l’aide de la directive inclut .

Lors de la synchronisation, le répertoire .gitbook/includes est créé à la racine de chaque espace synchronisé (qui peut ne pas être la racine de l’ensemble du dépôt). Si votre .gitbook/includes dossier ou ses fichiers apparaissent dans la table des matières de votre espace, vous devrez peut-être les masquer manuellement de la table des matières.

Exemple

Si vous écrivez du côté de GitHub, assurez-vous que le chemin vers l’inclusion est relatif au fichier contenant la référence (et non à la racine du dépôt).

{% include "../../.gitbook/includes/reusable-block.md" %}