Theme support for comments

jonathan's Avatar


03 Feb, 2018 08:28 PM

I believe there isn't a standardised way of inserting a comment in Markdown, though there is the CriticMarkup option. The most standard way in plain markdown is to use the HTML syntax <!- - and --> . I'd like to use one or the other, but want a way that can be coloured differently in a theme in MMC, and not appear in my PDF output, managed by a moderately involved Pandoc workflow.

So far I can't seem to get both my requirements. The HTML syntax isn't recognised by MMC and Pandoc doesn't support CriticMarkup, and it doesn't look likely to. Could MMC please recognise the HTML comments?

  1. Support Staff 1 Posted by Fletcher on 04 Feb, 2018 06:34 PM

    Fletcher's Avatar

    CriticMarkup is the standard approach for comments in MultiMarkdown. You are correct that Markdown has no such standardized feature.

    MMD (and therefore Composer) do not specifically distinguish between HTML and HTML comments under all circumstances -- MMD is not an HTML parser.

    That said, I did add tokens to the MMDC theme syntax to allow html and htmlComment support. This means that html can be highlighted differently. Keep in mind that an HTML comment that is actually a separate HTML Block will be highlighted as HTML, not an HTML comment. This will be included in the next release.

    All HTML, comment or not, is exported as is to the HTML output. So HTML Comments should not be used for "private" information. None of it is included in other output formats, since that would not make sense.

    Hope this helps!

  2. Fletcher closed this discussion on 04 Feb, 2018 06:34 PM.

  3. jonathan re-opened this discussion on 04 Feb, 2018 10:02 PM

  4. 2 Posted by jonathan on 04 Feb, 2018 10:02 PM

    jonathan's Avatar

    Thanks, @fletcher, that sounds what I'm after. I look forward to that in the next release.

  5. Fletcher closed this discussion on 08 Feb, 2018 02:34 AM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac