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 du contenu sur plusieurs pages et espaces, afin que vous puissiez modifier toutes les instances du bloc en même temps.
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 flux de travail de relecture, et il s'affichera correctement sur tout 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 apparaissent instantanément dans toutes les instances, toutes les modifications doivent provenir de l'espace parent — soit par une modification directe, soit via une demande de modification.
Les espaces sont un concept central dans GitBook, soutenant à la fois les flux de travail éditoriaux et la sécurité. Parce que GitBook applique une é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é 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 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 entre espaces briserait cette barriè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 à lever 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 également donner un nom à votre bloc pour le retrouver et le réutiliser plus facilement par la suite.
Vous pouvez aussi 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 ». Vous pouvez aussi cliquer 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 tout autre contenu — vous pouvez modifier n'importe quelle instance directement si les modifications en direct sont activées, ou via une demande de modification 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 modification, le contenu sera synchronisé avec toutes les autres instances une fois que cette demande de modification 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. Détacher convertira le contenu en blocs classiques.
Une fois détaché, toute modification apportée au(x) bloc(s) ne sera pas répercutée sur les autres instances, et les modifications apportées dans ces instances ne seront pas répercutées sur 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 entièrement 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 le supprimera de toutes les pages où il est utilisé. Cette action ne peut pas être annulée.
Synchronisation avec GitHub & GitLab
Le contenu réutilisable est entièrement pris en charge lors de la synchronisation avec GitHub & GitLab. Votre contenu réutilisable sera exporté dans un dossier dédié includes
, chaque contenu étant un fichier Markdown séparé.
Votre contenu est ensuite référencé dans vos autres pages en utilisant la directive include
.
Exemple
Si vous écrivez du côté de 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" %}
Mis à jour
Ce contenu vous a-t-il été utile ?