Question Commentaires dans Markdown


Quelle est la syntaxe pour stocker un commentaire dans un fichier de démarquage, par ex. un commentaire CVS $ Id $ en haut du fichier? Je n'ai rien trouvé sur le projet de démarque.


956
2018-01-28 00:18


origine


Réponses:


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

Si vous voulez un commentaire strictement pour vous-même (les lecteurs du document converti ne devraient pas pouvoir le voir, même avec "view source"), vous pouvez (ab) utiliser les labels de liens (à utiliser avec les liens de style référence) disponible dans la spécification de base Markdown:

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

C'est:

[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 pourriez aller plus loin:

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

Pour améliorer la compatibilité de la plate-forme (et enregistrer une frappe), il est également possible d'utiliser # (qui est une cible de lien hypertexte légitime) au lieu de <>:

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

Pour une portabilité maximale, il est important d'insérer une ligne vide avant et après ce type de commentaires, car certains analyseurs Markdown ne lient pas les définitions au texte standard. La recherche la plus récente avec Babelmark montre que les lignes blanches avant et après sont toutes deux importantes. Certains analyseurs produiront le commentaire s'il n'y a pas de ligne vide avant, et certains parseurs excluront la ligne suivante s'il n'y a pas de ligne vide après.

En général, cette approche devrait fonctionner avec la plupart des parseurs Markdown, car 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é).


990
2018-01-02 15:18



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 de sortie TeX ou HTML. Plus d'informations sont disponibles sur le pandoc-discuter groupe.


779
2018-01-28 15:36



Cette petite recherche prouve et affine la réponse de Magnus

La syntaxe la plus indépendante de la plate-forme est

(empty line)
[comment]: # (This actually is the most platform independent comment)

Les deux conditions sont importantes:

  1. En utilisant # (et pas <>)
  2. Avec une ligne vide avant le commentaire. La ligne vide après le commentaire n'a aucun impact sur le résultat.

La spécification stricte Markdown CommonMark fonctionne seulement comme prévu avec cette syntaxe (et non avec <> et / ou une ligne vide)

Pour le prouver, nous utiliserons le Babelmark2, écrit par John MacFarlane. Cet outil vérifie le rendu de code source particulier dans 28 implémentations Markdown.

(+ - passé le test, - - n'a pas passé, ? - laisse quelques déchets qui ne sont pas montrés en HTML rendu).

Cela prouve les déclarations ci-dessus.

Ces implémentations échouent tous les 7 tests. Il n'y a aucune chance d'utiliser des commentaires exclus-sur-rendre avec eux.

  • cebe / markdown 1.1.0
  • cebe / démarque MarkdownExtra 1.1.0
  • cebe / markdown GFM 1.1.0
  • s9e \ TextFormatter (Fatdown / PHP)

116
2017-08-24 19:17



Si vous utilisez Jekyll ou octopress, cela fonctionnera également.

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

Les étiquettes de liquide {% comment %} sont analysés en premier et supprimés avant même que le processeur MarkDown n'y arrive. Les visiteurs ne verront pas lorsqu'ils essaient de voir la source depuis leur navigateur.


42
2018-04-05 02:57



Une alternative consiste à mettre des commentaires dans les balises HTML stylisées. De cette façon, vous pouvez basculer leur visibilité au besoin. Par exemple, définissez une classe de commentaire 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 NAVIGATEUR

We do support comments


33
2018-02-22 18:11



Cela fonctionne sur GitHub:

[](Comment text goes here)

Le HTML résultant ressemble à:

<a href="Comment%20text%20goes%20here"></a>

Ce qui est essentiellement un lien vide. Évidemment, vous pouvez le lire dans la source du texte rendu, mais vous pouvez le faire sur GitHub de toute façon.


25
2018-04-19 00:19



Voir aussi Critic Markup, supporté 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.

15
2018-03-31 11:17



Pourquoi ne pas placer les commentaires dans un bloc non-eval, non-echo R? c'est à dire.,

```{r echo=FALSE, eval=FALSE}
All the comments!
```

Semble fonctionner bien pour moi.


11
2017-11-23 03:19