Syntax for comments

[olivierkes]

Hi, I was wondering if you were open to add a syntax for comments. Comments would be totally ignored by parser. I'm using txt2tags, and i'm so much used to them that it seems difficult to switch to mmd because of that. I know that right know we can use html comments, but it's not very convenient, and they would appear in html source. A simple syntax could be "% " or "# " at the beginning of a line. Regards,

[fletcher]

CriticMarkup already provides a syntax for comments:

{>>This is a comment<<}

http://fletcher.github.io/MultiMarkdown-5/criticmarkup.html

Fletcher

On 3/4/16 1:16 PM, Olivier wrote:

Hi, I was wondering if you were open to add a syntax for comments. Comments would be totally ignored by parser. I'm using txt2tags, and i'm so much used to them that it seems difficult to switch to mmd because of that. I know that right know we can use html comments, but it's not very convenient, and they would appear in html source. A simple syntax could be "% " or "# " at the beginning of a line. Regards,

— Reply to this email directly or view it on GitHub https://github.com/fletcher/MultiMarkdown-5/issues/12.

Fletcher T. Penney fletcher@fletcherpenney.net

[olivierkes]

Not the most convenient syntax to simply comment out a whole line or paragraph, but will do.

[jarnowic]

If you preprocess your input file with gpp, as explained by random determinism, you can define your comments any way you like, among other things...

[ickc]

Under the current mmd syntax, if you want to avoid using CriticsMarkup to comment (because one want to separate coding comment and editing comment), you can do something like:

<!-- \begin{comment}
    [COMMENT GOES HERE]
\end{comment} -->

Because HTML comments are ignored except in LaTeX output (according to the documentation), so using an extra LaTeX comment will guarantee it is a comment in all output formats.

The same tricks can be applied to more complicated situation, like this:

<!-- \begin{comment} -->
{{TOC}}
<!-- \end{comment} -->

which I included in almost all my mmd files, because I want the LaTeX generated TOC when the output is LaTeX, and otherwise let MMD do the work for me (seems like the obvious and reasonable expectation from TOC feature, and is the default behavior in pandoc with --toc args. But in MMD this is the workaround.)

• P.S. It is cumbersome, but the only "correct" way to do coding comment in mmd. I use text expansions app to help me do that so in practice that only costs a few key strokes.
• P.S.2 The original Markdown do not have a comment syntax, and since raw html is accepted in Markdown, using HTML comment is the "correct" way of commenting. However, since mmd is designed to use HTML comment for a function (which make sense, although it could be implemented differently), there seems no other way to do it than the workaround mentioned above. A completely new syntax can be created but that will be so not Markdown.
• P.S.3 done in this way, HTML output will still have the comment, but it makes sense to keep it there. Minifying HTML should be a separate job. (if you so happen use Jekyll, take a look at penibelst/jekyll-compress-html: A Jekyll layout that compresses HTML in pure Liquid which does not require plugin and hence gh-pages compatible).
• P.S.4 <!-- %[COMMENT GOES HERE] --> won't work since the HTML comment has closed, but LaTeX's doesn't.

[pischky]

In version 6.4.0 this workd for me when I need to comment out multiple lines:

<div style="display: none">
bla bla 
</div>

The source is included in HTML.