Question

如何评论Hugo中的内容？

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

<!--标签似乎无效 - 它甚至不会成为html评论，它仍然是页面上的可见文字。

Answer 1

您可以使用HTML注释，例如，但它们会显示在呈现的HTML中，因此您可以在浏览器中使用“查看源”查看它们。

在Markdown文档中没有正式的方法可以在最终的HTML中进行评论，但有一些tricks you can try可以使用。

或者，您可以制作自己的自定义评论短代码。使用以下代码在/layouts/shortcodes/comment.html创建一个文件：

<!-- {{ .Inner }} -->

（内部文本的短代码需要在其中的某个地方有{{ .Inner }}，但是您可以通过使用HTML注释来解决这个问题，在这种情况下，HTML注释会在它们包含在最终HTML之前被删除。）

您可以在Markdown文档中使用短代码，如下所示：

{{< comment >}}This is a comment that will not be rendered.{{< /comment >}}

Answer 2

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

Answer 3

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

Answer 4

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

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

因此您可以使用HTML注释

<!-- your comment text -->

在v0.55.0上确认