Commentaires en format Markdown

Question

Comment écrire un commentaire en Markdown, c'est-à-dire un texte qui n'est pas rendu dans la sortie HTML ? Je n'ai rien trouvé sur le site Projet Markdown .

Answer 1

Je pense que toutes les solutions proposées précédemment (à part celles qui nécessitent des implémentations spécifiques) font que les commentaires sont inclus dans le HTML de sortie, même s'ils ne sont pas affichés.

Si vous voulez un commentaire qui vous est strictement réservé (les lecteurs du document converti ne doivent pas pouvoir le voir, même avec "view source"), vous pouvez (ab)utiliser les étiquettes de lien (à utiliser avec les liens de style référence) qui sont disponibles dans la spécification Markdown de base :

http://daringfireball.net/projects/markdown/syntax#link

C'est-à-dire :

[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in  the output file unless you use it in)
[comment]: <> (a reference style link.)

Ou vous pouvez aller plus loin :

[//]: <> (This is also a comment.)

Pour améliorer la compatibilité des plates-formes (et pour économiser une frappe), il est également possible d'utiliser la fonction # (qui est une cible légitime d'hyperlien) au lieu de <> :

[//]: # (This may be the most platform independent comment)

Pour une portabilité maximale, il est important d'insérer une ligne vierge avant et après ce type de commentaires, car certains analyseurs Markdown ne fonctionnent pas correctement lorsque les définitions côtoient du texte ordinaire. Les recherches les plus récentes menées avec Babelmark montrent que les lignes vides avant et après sont toutes deux importantes. Certains analyseurs génèrent le commentaire s'il n'y a pas de ligne vierge avant, et certains analyseurs excluent la ligne suivante s'il n'y a pas de ligne vierge après.

En général, cette approche devrait fonctionner avec la plupart des analyseurs Markdown, puisqu'elle fait partie de la spécification de base. (même si le comportement lorsque plusieurs liens sont définis, ou lorsqu'un lien est défini mais jamais utilisé, n'est pas strictement spécifié).

Answer 2

J'utilise des balises HTML standard, comme

<!---
your comment goes here
and here
-->

Notez le triple tiret. L'avantage est que cela fonctionne avec pandoc lors de la génération d'une sortie TeX ou HTML. De plus amples informations sont disponibles sur le site pandoc-discuss groupe.

Answer 3

Si vous utilisez Jekyll ou octopress, les éléments suivants fonctionneront également.

{% comment %} 
    These commments will not include inside the source.
{% endcomment %}

Les étiquettes liquides {% comment %} sont analysés en premier et supprimés avant même que le processeur MarkDown ne s'en occupe. Les visiteurs ne verront rien lorsqu'ils essaieront d'afficher la source à partir de leur navigateur.

Answer 4

Une autre solution consiste à placer les commentaires dans des balises HTML stylisées. De cette façon, vous pouvez basculer leur visibilité selon vos besoins. Par exemple, définissez une classe de commentaires dans votre feuille de style CSS.

.comment { display: none; }

Ensuite, le MARKDOWN amélioré suivant

We do <span class="comment">NOT</span> support comments

apparaît comme suit dans un BROWSER

We do support comments

Answer 5

Voir également le balisage critique, pris en charge par un nombre croissant d'outils Markdown.

http://criticmarkup.com/

Comment {>> <<}

Lorem ipsum dolor sit amet.{>>This is a comment<<}

Highlight+Comment {== ==}{>> <<}

Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget nulla.==}{>>confusing<<} Mauris massa sem, tempor sed cursus et, semper tincidunt lacus.