如何在Markdown中编写注释,即HTML输出中未呈现的文本?我在Markdown项目中没有发现任何东西。
当前回答
你可以试试
[](
Your comments go here however you cannot leave
// a blank line so fill blank lines with
//
Something
)
其他回答
这在GitHub上有效:
[](Comment text goes here)
生成的HTML如下所示:
<a href="Comment%20text%20goes%20here"></a>
这基本上是一个空链接。显然,您可以在渲染文本的源代码中阅读,但无论如何您都可以在GitHub上阅读。
我相信,所有先前提出的解决方案(除了那些需要特定实现的解决方案)都会导致注释包含在输出HTML中,即使它们没有显示出来。
如果你想要一个完全属于你自己的评论(转换文档的读者应该看不到它,即使使用“查看源代码”),你可以(ab)使用核心Markdown规范中提供的链接标签(用于参考样式链接):
http://daringfireball.net/projects/markdown/syntax#link
即:
[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in the output file unless you use it in)
[comment]: <> (a reference style link.)
或者您可以进一步:
[//]: <> (This is also a comment.)
为了提高平台兼容性(并节省一次按键),也可以使用#(这是合法的超链接目标)而不是<>:
[//]: # (This may be the most platform independent comment)
为了实现最大的可移植性,在这种类型的注释前后插入一个空行是很重要的,因为某些Markdown解析器在定义碰到常规文本时无法正常工作。Babelmark的最新研究表明,前后空白行都很重要。如果前面没有空行,一些解析器将输出注释,如果后面没有空行则一些解析器将排除以下行。
通常,这种方法应该适用于大多数Markdown解析器,因为它是核心规范的一部分。(即使定义了多个链接时的行为,或定义了链接但从未使用时的行为也未严格指定)。
如果它在VS代码中,那么还有另一个好选项:
<span hidden> Some texts </span>
与“HTML注释标记”相比,它具有在编辑区域保持语法高亮显示的优势,以及为语义标记添加属性的能力,如<span notice hidden>。
警告:根据常识,不要在源代码中包含个人信息。
以下方法非常有效
<empty line>
[whatever comment text]::
该方法利用语法通过引用创建链接由于使用[1]创建了链接引用:http://example.org不会呈现,同样,以下任何内容也不会呈现
<empty line>
[whatever]::
[whatever]:whatever
[whatever]: :
[whatever]: whatever
[whatever]: # whatever with spaces
使用mkdocs时,添加mkdocs.yml:
- pymdownx.striphtml:
strip_comments: true
strip_js_on_attributes: false
然后在任何markdown文件中使用普通的html注释,如
<!-- this is a comment -->
将从html输出中删除。
推荐文章
- 使用pandoc从Markdown转换为PDF时设置空白大小
- 如何显示数学方程在一般github的markdown(不是github的博客)
- JavaScript错误(Uncaught SyntaxError:意外的输入结束)
- 在Bash中测试非零长度字符串:[-n "$var"]或["$var"]
- 使用Markdown的Sphinx而不是reST
- Shell脚本for循环语法
- 降价和图像对齐
- 这在PHP中意味着什么:->或=>
- C或c++中的单引号与双引号
- TypeScript注释的语法记录在哪里?
- “+new Date”中加号的作用是什么
- CSV文件可以有注释吗?
- 在Python中%的结果是什么?
- 如何样式一个JSON块在Github维基?
- 标记“本机”文本对齐方式