Banc d'essai pour le contenu partagé¶
Cette section est incluse dans le but de vérifier le contenu partagé fourni par ce dépôt pour l'utiliser dans le reste de la documentation BeeWare. Le "contenu partagé" fait référence à des documents ou des sections de documents qui sont communs à plusieurs autres dépôts. Ils sont stockés ici pour être inclus dans tous ces dépôts. Cela signifie qu'il n'y a qu'une seule source lorsque des mises à jour sont nécessaires, et que le changement sera répercuté dans tous les dépôts utilisant ce contenu partagé.
Si vous mettez à jour un contenu existant, les étapes suivantes ne sont pas nécessaires. Vous pouvez simplement créer le site de test et voir le rendu de vos mises à jour.
If you are creating a new shared documentation file in the shared-content
directory, that is NOT meant to be included in the how-to directory, complete
the following:
- Créez un fichier dans le
content_test_bedqui a le même nom que votre nouveau fichier de contenu, avec "_include" ajouté à la fin. - Pour
style_guide.md, vous devez ajouterstyle_guide_include.md. - En utilisant la syntaxe des Snippets, ajoutez le nom de fichier à
filename_include.md. La syntaxe Snippets pour inclure du contenu est-8<- "filename.md". - Pour
style_guide.md, vous devez ajouter-8<- "style_guide.md"àstyle_guide_include.md. - Mettre à jour la section
Shared content test beddans/docs/SUMMARY.mdpour inclure le nouveau fichier_includeet le chemin, au même niveau d'indentation que les autres éléments de cette section. - Pour
style_guide_include.md, vous devez ajouter- [Style guide](content_test_bed/style_guide_include.md).
Une fois ces étapes terminées, vous pouvez créer le site de test et visualiser votre nouvelle documentation rendue.