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.

HTML Comment Tag

Syntax

<!-- This is comment.-->

Example

<!-- This is comment.-->

Try this code ❯

GitHub Comment

The Github markdown supports the following comments:

Single line comments
Multiple line comments

Single line comments:

Example

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

Try this code ❯

Multiple line comments:

Example

{::comment}
# Heading

This is paragraph.

{:/comment}

Try this code ❯