使用mkdocs时，添加mkdocs.yml：

  - pymdownx.striphtml:
      strip_comments: true
      strip_js_on_attributes: false

然后在任何markdown文件中使用普通的html注释，如

<!-- this is a comment -->

将从html输出中删除。

我使用标准的HTML标记，例如

<!---
your comment goes here
and here
-->

注意三点划线。其优点是，在生成TeX或HTML输出时，它可以与pandoc一起工作。有关更多信息，请访问pandoc讨论组。

如果它在VS代码中，那么还有另一个好选项：

<span hidden> Some texts </span>

与“HTML注释标记”相比，它具有在编辑区域保持语法高亮显示的优势，以及为语义标记添加属性的能力，如＜span notice hidden＞。

警告：根据常识，不要在源代码中包含个人信息。

另请参见由越来越多的Markdown工具支持的Critic Markup。

http://criticmarkup.com/

Comment {>> <<}

Lorem ipsum dolor sit amet.{>>This is a comment<<}

Highlight+Comment {== ==}{>> <<}

Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget nulla.==}{>>confusing<<} Mauris massa sem, tempor sed cursus et, semper tincidunt lacus.

使用mkdocs时，添加mkdocs.yml：

  - pymdownx.striphtml:
      strip_comments: true
      strip_js_on_attributes: false

然后在任何markdown文件中使用普通的html注释，如

<!-- this is a comment -->

将从html输出中删除。

kramdown基于Ruby的markdown引擎，这是Jekyll的默认引擎，因此GitHubPages通过其扩展语法内置了注释支持：

{::comment}
This text is completely ignored by kramdown - a comment in the text.
{:/comment}

Do you see {::comment}this text{:/comment}?
{::comment}some other comment{:/}

这样做的好处是允许在线评论，但缺点是不能移植到其他Markdown引擎。