Markdown中的注释

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

当前回答

将注释放在非eval、非echo R块中怎么样？即。，

```{r echo=FALSE, eval=FALSE}
All the comments!
```

对我来说似乎很好。

其他回答

对于pandoc，一个阻止评论的好方法是使用yaml元块，正如pandoc作者所建议的那样。我注意到，至少在我的环境中（vim、vim-pandoc和vim-pandocsyntax），与许多其他建议的解决方案相比，这为注释提供了更恰当的语法高亮显示。

我将yaml块注释与html内联注释结合使用，因为html注释不能嵌套。不幸的是，在yaml元块中没有块注释的方法，所以每一行都必须单独注释。幸运的是，软包装的段落中应该只有一行。

在我的~/.vimrc中，我为块注释设置了自定义快捷方式：

nmap <Leader>b }o<Esc>O...<Esc>{ji#<Esc>O---<Esc>2<down>
nmap <Leader>v {jddx}kdd

我分别使用so、b和v注释和取消注释段落，作为我的<Leader>键。如果我需要注释多个段落，我将j，b映射到一个宏（通常为Q），然后运行＜段落数＞＜宏名＞（例如（3Q）。这同样适用于取消注释。

你可以试试

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

使用mkdocs时，添加mkdocs.yml：

  - pymdownx.striphtml:
      strip_comments: true
      strip_js_on_attributes: false

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

<!-- this is a comment -->

将从html输出中删除。

披露：我写了这个插件。

由于问题没有指定特定的markdown实现，我想提到python markdown的Comments插件，它实现了上述相同的pandoc注释样式。

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

.注释｛display:none；｝

然后，以下增强的MARKDOWN

我们不支持评论

在浏览器中显示如下

我们支持评论

推荐文章