Contenu réutilisable

Créez des blocs de contenu réutilisables pouvant être utilisés dans plusieurs espaces et mis à jour simultanément lorsque vous modifiez une instance

This feature is available on Pro and Enterprise plans.

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

Créer du contenu réutilisable au sein d'un espace.

Principes de base

Le contenu réutilisable fonctionne comme n'importe quel autre contenu : vous pouvez le modifier via des demandes de modification, l'inclure dans des workflows de revue, 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 instances, toutes les modifications doivent provenir de l'espace parent — soit sous forme de modification directe, soit via une demande de modification.

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

Limitations connues

Intégrations

Les blocs fournis par des intégrations ne sont pas pris en charge dans le contenu réutilisable. Cela s'explique par le fait que les intégrations dans GitBook sont installées par espace, et limiter l'accès garantit que les intégrations tierces n'ont que les permissions que vous accordez. Référencer du contenu réutilisable à travers des 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 Actions , sélectionnez Transformer en, et choisissez Contenu réutilisable. Vous pouvez aussi donner un nom à votre bloc pour le rendre plus facile à trouver et à réutiliser plus tard.

Alternativement, vous pouvez sélectionner un ou plusieurs blocs puis appuyer sur Cmd + C pour ouvrir une invite 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 en recherchant simplement « réutilisable ». Alternativement, 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 trouver 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 instance si modifications en direct sont activées, ou via une demande de modification si ce n'est pas le cas. Toutes les modifications que vous effectuez seront synchronisées partout où le contenu est utilisé.

Si vous apportez des modifications dans le cadre d'une demande de modification, le contenu sera synchronisé avec toutes les autres instances une fois que cette demande sera fusionnée.

Détacher le contenu réutilisable

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

Une fois détaché, les modifications que vous apportez au(x) bloc(s) ne seront pas reflétées dans les autres instances, et les modifications que vous apportez dans ces instances ne seront pas reflétées dans le(s) bloc(s) détaché(s). Toutes les autres instances 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 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 & GitLab

Le contenu réutilisable est entièrement pris en charge lors de la synchronisation vers GitHub & GitLab. Votre contenu réutilisable sera exporté vers un dossier includes , chaque contenu étant un fichier Markdown séparé.

Votre contenu est ensuite référencé dans vos autres pages en utilisant la dossier includes directive.

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 répertoire .gitbook/includes dossier ou ses fichiers apparaissent dans la table des matières de votre espace, vous devrez peut-être les masquer manuellement du TOC.

Exemple

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

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