如何在 Hugo 中注释掉内容

Posted 2023-02-21

【中文标题】如何在 Hugo 中注释掉内容

【英文标题】：How to comment out content in Hugo

【发布时间】：2017-12-26 17:51:54

【问题描述】：

？

如果我有笔记和未完成的想法，我想将它们留在.md 文件中，但不要让它们出现在html 中。

<!-- 标记似乎不起作用——它甚至没有变成 html 注释，它仍然是页面上的可见文本。

【问题讨论】：

<!-- the text -->

啊，需要结束-->标签谢谢

没问题的人....很高兴帮助:)

【参考方案1】：

Hugo 在后台使用Go templates，因此注释语法为/* a comment */。注释中的任何内容都不会呈现到生成的 HTML 文件中。

Official Hugo comments documentation

【讨论】：

这仍然会在 HTML 中呈现 /* 和 */ 之间的文本，至少在我使用多行注释文本的测试用例中是这样。

@gbmhunter：听起来很奇怪。我一直使用它没有问题。也适用于多行 cmets。

该操作似乎在降价文件中询问，我遇到了同样的问题

@ClarenceLiu：这实际上是一个好点。 :) 没有那样读。

【参考方案2】：

请参阅此示例以了解可用于在内容文件中添加 cmets 的无操作 shortcode：

https://github.com/gohugoio/hugoDocs/blob/master/layouts/shortcodes/todo.html

【讨论】：

Go cmets 对我不起作用，因为它们还是被渲染了。但是创建这样的自定义短代码效果很好。

【参考方案3】：

官方文档说，HTML 注释不会呈现到最终的 HTML 页面。

默认情况下，HTML cmets 会被剥离，但它们的内容仍然是 评估。这意味着尽管 HTML 注释永远不会呈现 最终 HTML 页面的任何内容，注释中包含的代码 可能会导致构建过程失败。

https://gohugo.io/templates/introduction/#html-comments-containing-go-templates

所以你可以像这样使用 HTML 注释

<!-- your comment text -->

在 v0.55.0 上确认