( + - passed the test, - didn't pass, ? - leaves some garbage which is not shown in rendered HTML). This tool checks the rendering of particular source code on a large number of Markdown implementations.
To prove this we shall use the Babelmark I, by Alexandre Mutel. The strict Markdown specification CommonMark only works as intended with this syntax (and not with and/or an empty line) Empty line after the comment has no impact on the result. With an empty line before the comment.: # (This actually is the most platform independent comment) The most platform-independent syntax is (empty line) This small research proves and refines the answer by Magnus (even if the behavior when multiple links are defined, or when a link is defined but never used, is not strictly specified). In general, this approach should work with most Markdown parsers, since it's part of the core specification. Some parsers will output the comment if there is no blank line before, and some parsers will exclude the following line if there is no blank line after. The most recent research with Babelmark shows that blank lines before and after are both important. To improve platform compatibility (and to save one keystroke) it is also possible to use # (which is a legitimate hyperlink target) instead of : : # (This may be the most platform independent comment)įor maximum portability it is important to insert a blank line before and after this type of comments, because some Markdown parsers do not work correctly when definitions brush up against regular text. Or you could go further: : (This is also a comment.) : (in the output file unless you use it in)
That is: : (This is a comment, it will not be included) If you want a comment that is strictly for yourself (readers of the converted document should not be able to see it, even with "view source") you could (ab)use the link labels (for use with reference style links) that are available in the core Markdown specification: I believe that all the previously proposed solutions (apart from those that require specific implementations) result in the comments being included in the output HTML, even if they are not displayed.
0 kommentar(er)
