Ce guide de référence détaille toutes les options de formatage disponibles dans les publications Discourse, y compris le markdown, le BBCode et le HTML. Il spécifie ce qui est pris en charge et fournit des ressources où vous pouvez voir des exemples.
Niveau d’utilisateur requis : Tous les utilisateurs
Comprendre le formatage pris en charge dans les publications
Bien que le texte brut suffise pour la plupart des réponses, Discourse permet aux utilisateurs d’améliorer le formatage de leurs publications en utilisant le markdown, le BBCode et le HTML. Ce guide explique quels types de formatage sont pris en charge et comment vous pouvez les utiliser efficacement.
Vous pouvez également vous exercer sur quelques bases dans un tutoriel interactif en envoyant un message privé à @discobot ici ou sur n’importe quel site Discourse.
Résumé
Ce guide couvre :
- La syntaxe markdown prise en charge
- Les balises BBCode prises en charge
- Les balises et attributs HTML pris en charge et sûrs
Bonnes pratiques
- Utilisez le markdown principalement pour sa simplicité et sa lisibilité.
- Mélangez le markdown et le BBCode uniquement lorsque cela est nécessaire, et maintenez une utilisation cohérente.
- Limitez l’utilisation du HTML aux balises simples et sûres pour éviter les problèmes de formatage et garantir la sécurité des publications.
Markdown pris en charge
Discourse utilise markdown-it pour son implémentation markdown.
Certaines fonctionnalités markdown couramment utilisées incluent :
-
Gras :
**texte** -
Italique :
*texte* -
Lien :
[titre](https://example.com) -
Code en ligne:`code` -
Surligner :
<mark></mark> -
Bloc de code :
``` bloc de code ```
Dans les publications plus longues (comme celle-ci), il peut également être utile d’ajouter une structure à l’aide de titres :
# Titre 1
## Titre 2
### Titre 3
Remarque : lorsqu’une image est téléchargée, la syntaxe markdown pour référencer l’image sera générée automatiquement.
Pour une liste complète des fonctionnalités markdown, veuillez vous référer au guide interactif.
BBCode pris en charge
Discourse prend en charge un sous-ensemble de balises BBCode courantes, dont certaines sont générées automatiquement pour prendre en charge un formatage spécial, par exemple lorsque vous citez une publication dans votre réponse :
[quote=“utilisateur”]texte cité[/quote]
[quote="utilisateur"]texte cité[/quote]
Vous pouvez également utiliser le BBCode pour marquer du texte masqué comme un spoiler ou comme des détails
texte révélé
[spoiler]texte révélé[/spoiler]
[details=“cliquer pour développer”]texte masqué[/details]
[details="cliquer pour développer"]texte masqué[/details]
Les balises BBCode pour un formatage simple pris en charge par le markdown ou sont également prises en charge :
[b]texte en gras[/b][i]emphase[/i][u]souligné[/u][s]barré[/s][ul][li]option un[/li][/ul][img]http://example.com/image.png[/img][url]http://example.com[/url][code]code[/code]
Pour une liste complète des balises BBCode prises en charge et des exemples, consultez les tests BBCode de Discourse.
HTML pris en charge
Discourse prend en charge un sous-ensemble sûr de HTML. Bien que vous puissiez mélanger le HTML avec le markdown, seules des balises et attributs HTML spécifiques sont autorisés pour garantir la sécurité et un style cohérent.
Parmi les balises HTML autorisées figurent :
<a href="https://example.com">lien</a><strong>texte en gras</strong><em>texte en italique</em><ul><li>élément de liste</li></ul><img src="https://example.com/image.png" alt="description">
Pour une liste détaillée des balises et attributs HTML autorisés, consultez la liste blanche de Discourse.
Remarque : Les styles en ligne, comme <span>texte en couleur</span>, ne sont pas pris en charge. Pour des styles personnalisés, consultez personnaliser le contenu des publications.
Problèmes courants et solutions
- Les balises BBCode ou HTML ne fonctionnent pas : Assurez-vous que les balises que vous utilisez font partie du sous-ensemble pris en charge.
- Les styles en ligne sont supprimés : Discourse ne prend pas en charge les styles en ligne pour des raisons de sécurité. Utilisez des styles personnalisés ou des plugins si nécessaire.
- Le formatage change lors du collage depuis d’autres éditeurs : Certains formats de texte enrichi peuvent ne pas s’afficher correctement. Utilisez le markdown pour formater le texte de manière cohérente.
FAQ
Q : Puis-je utiliser des tableaux dans Discourse ?
R : Oui, vous pouvez utiliser le markdown pour créer des tableaux. Pour plus d’informations, consultez ce guide sur les tableaux.
Q : Pourquoi mon style en ligne ne fonctionne-t-il pas ?
R : Discourse ne prend pas en charge les styles en ligne en HTML pour des raisons de sécurité. Envisagez d’utiliser un BBCode personnalisé ou le guide de style personnalisé de Discourse.
Q : Puis-je ajouter des balises BBCode personnalisées ?
R : Oui, vous pouvez ajouter des balises BBCode personnalisées. Consultez le plugin BBCode de Discourse pour plus d’informations.
Ressources supplémentaires
- Guide interactif markdown : https://markdown-it.github.io/
- Personnaliser le contenu des publications : Customize posts' contents with your own styles
- Plugin BBCode de Discourse : Discourse BBCode
