syntax - comment - markdown video




Kommentare in Markdown (10)

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


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.


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 von # (und nicht <> )
  2. Mit einer leeren Zeile vor dem Kommentar . Leere Zeile nach dem Kommentar hat keinen Einfluss auf das Ergebnis.

Die strikte Markdown-Spezifikation CommonMark funktioniert nur mit dieser Syntax (und nicht mit <> und / oder einer leeren Zeile)

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

( + - hat den Test bestanden, - - hat nicht bestanden ? - hinterlässt einen 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)

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


Für Pandoras ist eine gute Möglichkeit, Kommentare zu blockieren, die Verwendung eines Yamlock-Metablocks, wie vom Pandov-Autor vorgeschlagen . Ich habe festgestellt, dass dies zu einer besseren syntaktischen Hervorhebung der Kommentare im Vergleich zu vielen der anderen vorgeschlagenen Lösungen führt, zumindest in meiner Umgebung ( vim , vim-pandoc und vim-pandoc-syntax ).

Ich benutze YAML-Block-Kommentare in Kombination mit HTML-Inline-Kommentaren, da HTML-Kommentare nicht geschachtelt werden können . Leider gibt es keine Möglichkeit, den Kommentar im Yaml Metablock zu blockieren , so dass jede Zeile einzeln kommentiert werden muss. Glücklicherweise sollte es nur eine Zeile in einem Softwrapping-Absatz geben.

In meinem ~/.vimrc ich benutzerdefinierte Verknüpfungen für ~/.vimrc eingerichtet:

nmap <Leader>b }o<Esc>O...<Esc>{ji#<Esc>O---<Esc>2<down>
nmap <Leader>v {jddx}kdd

Ich benutze , wie meine <Leader> -Taste, also ,b und ,v einen Absatz kommentieren bzw. auskommentieren. Wenn ich mehrere Absätze kommentieren muss, ordne ich j,b einem Makro (normalerweise Q ) zu und führe <number-of-paragraphs><name-of-macro> (zB ( 3Q ). Dasselbe gilt für das Auskommentieren.


Ich verwende Standard-HTML-Tags, wie

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

Beachten Sie den Dreifachstrich. Der Vorteil ist, dass es beim Erzeugen von TeX- oder HTML-Ausgaben mit pandoc funktioniert. Weitere Informationen finden Sie in der Gruppe pandoc-discuss .


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.

Wenn Sie Jekyll oder Octopress verwenden, funktioniert auch folgendes.

{% 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.


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

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

Scheint gut für mich zu funktionieren.


Offenlegung: Ich habe das Plugin geschrieben.

Da die Frage keine spezielle Abschrift-Implementierung spezifiziert, möchte ich das Kommentare-Plugin für python-markdown markdown erwähnen, das den gleichen oben erwähnten Pandom-Kommentar-Stil implementiert.


<!--- ... --> 

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.





markdown