Markdown Comments

Comments are a useful for adding extra information about markdown line or code.

Markdown has no support for comment syntax, but extended syntax vendors like GitHub and stackoverflow have provided the syntax, and can not be used with markdown syntax.

HTML Comment Tag

You can also use HTML comment tag if your markdown application is supported.

Syntax:

<!-- This is comment.-->

<!-- This is comment.-->

GitHub Comment

The Github markdown supports the following comments:

• Single line comments
• Multiple line comments

Single line comments:

Syntax:

{::comment} This is comment. {:/comment}

{::comment} This is comment. {:/comment}

Multiple line comments:

Syntax:

{::comment}
This is comment.
{:/comment}

{::comment}
# Heading

This is paragraph.

{:/comment}