How to comment out content in Hugo

Question

How do I comment out content in Hugo?

If I have notes, unfinished thoughts, I'd like to leave them in the .md file but not have them appear in the html.

<!-- tags don't seem to work -- it doesn't even become a html comment, it remains visible text on the page.

ah, needs the closing `-->` tag thanks – mjeppesen Jul 20 '17 at 20:48 — mjeppesen, Jul 20 '17 at 20:48
No problem man....glad to help :) – Hackerman Jul 20 '17 at 20:55 — Hackerman, Jul 20 '17 at 20:55

Henrik Aasted Sørensen · Answer 1 · 2019-01-29T11:25:51.177

18

Hugo uses Go templates under the hood, so the comment syntax is {{/* a comment */}}. Anything inside the comment will not be rendered to the resulting HTML files.

Official Hugo comments documentation

edited Jan 29 '19 at 11:25

answered Jan 23 '19 at 12:22

Henrik Aasted Sørensen

6,966
11
51
60

4

This still renders the text between `{{/*` and `*/}}` in the HTML, at least in the test case I had with multi-line comment text. – gbmhunter Jul 27 '19 at 23:02
@gbmhunter: Sounds strange. I use it all the time without issues. Also for multi-line comments. – Henrik Aasted Sørensen Jul 29 '19 at 05:29
8

The op is asking about within markdown files it seems, I had the same issue – Clarence Liu May 05 '20 at 12:06
@ClarenceLiu: That's actually a good point. :) Had not read it that way. – Henrik Aasted Sørensen May 06 '20 at 07:44

score 14 · Answer 2 · answered Jul 30 '19 at 07:26

Official doc says, HTML comment does not rendered to final HTML pages.

HTML comments are by default stripped, but their content is still evaluated. That means that although the HTML comment will never render any content to the final HTML pages, code contained within the comment may fail the build process.

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

So you can use HTML comment like this

<!-- your comment text -->

Confirmed on v0.55.0

This does work only in *templates* but not in the *content*. The linked reference also points into the templating section. (hugo v0.104.3) — A.H., Oct 16 '22 at 11:03

score 12 · Accepted Answer · answered Jul 22 '17 at 08:45

12

See this example for a no-op shortcode that can be used to add comments in content files:

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

answered Jul 22 '17 at 08:45

bep

1,662
15
16

1

Go comments didn't work for me as they got rendered anyway. But creating a custom shortcode like this worked excellent. – Andreas Bergström Mar 06 '19 at 09:37

How to comment out content in Hugo

3 Answers3