Markdown : organiser le sens avant la présentation
Markdown convient aux notes et à la documentation parce que sa source reste lisible comme texte. Son intérêt est de distinguer titres, paragraphes et listes, pas de multiplier les signes de mise en forme.
Un titre ne se réduit pas à une taille de police
Commencez par le sujet du document, puis placez les sections à un niveau inférieur. # et ## suivis d’une espace indiquent des niveaux distincts ; tout mettre au premier niveau supprime cette hiérarchie.
Utilisez une liste pour des éléments séparés, un paragraphe pour expliquer leurs relations. La mise en forme soutient une phrase claire, elle ne la remplace pas.
Références: CommonMark 0.31.2 — Structured text, headings and rendering differences
L’aperçu ne représente pas tous les environnements
Les extensions Markdown diffèrent. Un tableau accepté par un éditeur ne garantit pas un rendu identique ailleurs ; vérifiez le document là où il sera lu.
ToolRoof affiche et exporte du HTML sans exécuter le HTML brut saisi. Les images externes sont remplacées par leur description et les liens restent inactifs dans l’aperçu. Ce n’est pas une reproduction complète de page web.
Références: CommonMark 0.31.2 — Structured text, headings and rendering differences
Conservez la source avec la version présentée
La source Markdown aide à comparer les révisions. HTML sert à présenter le contenu, mais une conversion inverse ne restitue pas nécessairement la source exacte.
Relisez contenu et liens avant diffusion. L’aperçu ne prouve ni l’exactitude des informations, ni la sûreté des sites liés, ni votre droit de réutiliser un contenu tiers.
Exemple : une courte note de réunion
Écrivez # Programme hebdomadaire, puis ## Priorités, puis - Relire le résumé et - Envoyer le brouillon sur des lignes distinctes. Vous obtenez un titre, un sous-titre et une liste de 2 éléments, pas 4 paragraphes indistincts.
#Programme hebdomadaire sans espace ne forme pas un titre ATX. Du code entre accents graves reste du texte affiché : le voir dans l’aperçu ne l’exécute pas et n’en prouve pas la validité.