Frage Kommentare in Markdown


Wie lautet die Syntax zum Speichern eines Kommentars in einer Markdown-Datei, z. ein CVS $ Id $ Kommentar am Anfang der Datei? Ich habe nichts gefunden Abschriftenprojekt.


956
2018-01-28 00:18


Ursprung


Antworten:


Ich glaube, dass alle zuvor vorgeschlagenen Lösungen (abgesehen von denen, die bestimmte Implementierungen erfordern) dazu führen, dass die Kommentare in der Ausgabe-HTML enthalten sind, auch wenn sie nicht angezeigt werden.

Wenn Sie einen Kommentar haben möchten, der ausschließlich für Sie selbst bestimmt ist (Leser des konvertierten Dokuments sollten es nicht sehen können, selbst mit "Quelltext anzeigen"), könnten Sie die Link-Labels (zur Verwendung mit Referenz-Style-Links) verwenden verfügbar in der Markdown-Kernspezifikation:

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

Das ist:

[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.)

Oder du könntest weiter gehen:

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

Um die Plattformkompatibilität zu verbessern (und um einen Tastendruck zu speichern), ist es auch möglich, zu verwenden # (was ein legitimes Hyperlinkziel ist) statt <>:

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

Für eine maximale Portabilität ist es wichtig, vor und nach dieser Art von Kommentaren eine Leerzeile einzufügen, da einige Markdown-Parser keine Definitionen mit normalem Text verknüpfen. Die jüngste Forschung mit Babelmark zeigt, dass Leerzeilen vor und nach dem Wort wichtig sind. Einige Parser geben den Kommentar aus, wenn zuvor keine Leerzeile vorhanden ist, und einige Parser schließen die folgende Zeile aus, wenn keine Leerzeile vorhanden ist.

Im Allgemeinen sollte dieser Ansatz mit den meisten Markdown-Parsern funktionieren, da er Teil der Kernspezifikation ist. (Auch wenn das Verhalten, wenn mehrere Links definiert sind oder wenn ein Link definiert, aber niemals verwendet wird, nicht genau angegeben ist).


990
2018-01-02 15:18



Ich verwende Standard-HTML-Tags, wie

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

Beachten Sie den Dreifachstrich. Der Vorteil ist, dass es mit Pandora beim Generieren von TeX- oder HTML-Ausgaben. Weitere Informationen finden Sie auf der Pandoc-diskutieren Gruppe.


779
2018-01-28 15:36



Diese kleine Forschung beweist und verfeinert die Antwort von Magnus

Die plattformunabhängigste Syntax ist

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

Beide Bedingungen sind wichtig:

  1. Verwenden # (und nicht <>)
  2. Mit einer leeren Zeile vor dem Kommentar. Leere Zeile nach dem Kommentar hat keinen Einfluss auf das Ergebnis.

Die strenge Markdown-Spezifikation Gemeinsamkeit funktioniert nur wie vorgesehen mit dieser Syntax (und nicht mit <> und / oder eine leere Zeile)

Um dies zu beweisen, verwenden wir das Babelmark2 von John MacFarlane. Dieses Tool überprüft das Rendern bestimmter Quellcodes in 28 Markdown-Implementierungen.

(+ - den Test bestanden, - - ist nicht gegangen, ? - hinterlässt etwas Müll, der im gerenderten HTML nicht angezeigt wird.

Dies beweist die obigen Aussagen.

Diese Implementierungen schlagen alle 7 Tests fehl. Es gibt keine Möglichkeit, Kommentare zum Ausschluss-Rendern mit ihnen zu verwenden.

  • cebe / Abschlag 1.1.0
  • cebe / markdown MarkdownExtra 1.1.0
  • cebe / markdown GFM 1.1.0
  • s9e \ TextFormatter (Fatdown / PHP)

116
2017-08-24 19:17



Wenn Sie Jekyll oder Octopress verwenden, funktioniert das auch.

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

Die Liquid-Tags {% comment %} werden zuerst geparst und entfernt, bevor der MarkDown-Prozessor überhaupt dazu gelangt. Besucher werden nicht sehen, wenn sie versuchen, Quelle von ihrem Browser zu sehen.


42
2018-04-05 02:57



Eine Alternative besteht darin, Kommentare in stilisierte HTML-Tags einzufügen. Auf diese Weise können Sie ihre Sichtbarkeit nach Bedarf umschalten. Definieren Sie beispielsweise eine Kommentarklasse in Ihrem CSS-Stylesheet.

.comment { display: none; }

Dann das folgende verbesserte MARKDOWN

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

erscheint in einem BROWSER wie folgt

We do support comments


33
2018-02-22 18:11



Dies funktioniert auf GitHub:

[](Comment text goes here)

Das resultierende HTML sieht folgendermaßen aus:

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

Das ist im Grunde ein leerer Link. Natürlich können Sie das in der Quelle des gerenderten Textes lesen, aber Sie können das auf GitHub trotzdem tun.


25
2018-04-19 00:19



Siehe auch Critic Markup, unterstützt von einer zunehmenden Anzahl von Markdown-Tools.

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



Wie wäre es mit den Kommentaren in einen nicht-eval, nicht-Echo R-Block? d.h.

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

Scheint gut für mich zu funktionieren.


11
2017-11-23 03:19



Offenlegung: Ich habe das Plugin geschrieben.

Da die Frage keine spezifische Abschriftenimplementierung spezifiziert, möchte ich das erwähnen Kommentare Plugin zum Python-Abschrift, die denselben oben erwähnten Pandoc-Kommentarstil implementiert.


10
2017-08-22 10:00



<!--- ... --> 

Funktioniert nicht in Pandoc Markdown (Pandoc 1.12.2.1). Kommentare erschienen immer noch in html. Folgendes hat funktioniert:

Blank line
[^Comment]:  Text that will not appear in html source
Blank line

Dann verwenden Sie die + Fußnotenerweiterung. Es ist im Wesentlichen eine Fußnote, die nie referenziert wird.


9
2018-02-23 16:13



Vim Sofortiger Abschlag Benutzer müssen verwenden

<!---
First comment line...
//
_NO_BLANK_LINES_ARE_ALLOWED_
//
_and_try_to_avoid_double_minuses_like_this_: --
//
last comment line.
-->

8
2017-11-01 18:47