Markdown中的注释

如何在Markdown中编写注释，即HTML输出中未呈现的文本？我在Markdown项目中没有发现任何东西。

当前回答

对于PandocMarkdown，我使用带有注释的反引号作为内联“代码”语法的语言

`here's a comment`{=comment}

这将在所有输出中自动过滤掉。它只是重载它们的代码语法，也适用于多行注释的代码块。我还没有尝试过，但我猜这对非潘多克·马克顿来说不起作用。

其他回答

另一种方法是将注释放在样式化的HTML标记中。这样，您可以根据需要切换它们的可见性。例如，在CSS样式表中定义注释类。

.注释｛display:none；｝

然后，以下增强的MARKDOWN

我们不支持评论

在浏览器中显示如下

我们支持评论

此Markdown注释不会在带有Jekyll的GitHub Pages网站上呈现

[whatever]: text

因为Jekyll使用Liquid模板语言来处理模板，所以这个Liquid注释也不会在使用Jekyll的GitHubPages网站上呈现

{% comment %}
This is a long comment string 

Newline

Stuff
{% endcomment %}

我编写了一个小awk程序来过滤添加到文本中的#omitbegine和#omitend标记。我使用awk将其输出通过管道传输到pandoc可以处理的临时文件。像这样：

awk-f省略过滤器.awk aim2_article.md>aim2_aArticle_tmp.md

pandoc--pdf engine=xelatex--lua filter=pagebreak.lua--filter pandoc crossref--citeproc aim2_article_tmp.md-o aim2_aarticle.pdf

这里是省略筛选器.awk：

/#omitbegin/ {
    insideOmit = 1;
}

! insideOmit {
    print $0
}

/#omitend/ {
    insideOmit = 0;
}

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

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

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

你可以试试

[](
Your comments go here however you cannot leave
// a blank line so fill blank lines with
//
Something
)

推荐文章