如何在Markdown中编写注释,即HTML输出中未呈现的文本?我在Markdown项目中没有发现任何东西。
当前回答
我编写了一个小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;
}
其他回答
如果您正在使用Jekyll或octopress,下面的操作也会起作用。
{% comment %}
These commments will not include inside the source.
{% endcomment %}
Liquid标记{%comment%}首先被解析,并在MarkDown处理器到达它之前被删除。访问者在尝试从浏览器查看源代码时将看不到。
这在GitHub上有效:
[](Comment text goes here)
生成的HTML如下所示:
<a href="Comment%20text%20goes%20here"></a>
这基本上是一个空链接。显然,您可以在渲染文本的源代码中阅读,但无论如何您都可以在GitHub上阅读。
你可以试试
[](
Your comments go here however you cannot leave
// a blank line so fill blank lines with
//
Something
)
如果它在VS代码中,那么还有另一个好选项:
<span hidden> Some texts </span>
与“HTML注释标记”相比,它具有在编辑区域保持语法高亮显示的优势,以及为语义标记添加属性的能力,如<span notice hidden>。
警告:根据常识,不要在源代码中包含个人信息。
此Markdown注释不会在带有Jekyll的GitHub Pages网站上呈现
[whatever]: text
因为Jekyll使用Liquid模板语言来处理模板,所以这个Liquid注释也不会在使用Jekyll的GitHubPages网站上呈现
{% comment %}
This is a long comment string
Newline
Stuff
{% endcomment %}
推荐文章
- 问号运算符是关于什么的?
- 在Ruby中->运算符叫什么?
- 自动TOC在github风味markdown
- Jenkins:注释可以添加到Jenkins文件中吗?
- 在shell脚本中使用$()而不是反引号的好处是什么?
- ASP。NET“特殊”标签
- 使用pandoc从Markdown转换为PDF时设置空白大小
- 如何显示数学方程在一般github的markdown(不是github的博客)
- JavaScript错误(Uncaught SyntaxError:意外的输入结束)
- 在Bash中测试非零长度字符串:[-n "$var"]或["$var"]
- 使用Markdown的Sphinx而不是reST
- Shell脚本for循环语法
- 降价和图像对齐
- 这在PHP中意味着什么:->或=>
- C或c++中的单引号与双引号