Skip to content

Comments

Keep notes or temporarily disable content without deleting it.

AI-assisted, human-approvednovem uses AI to review and keep our documentation up to date.

Available in: documents and e-mails.

Syntax

Use HTML comments or JSX-style comments. Both may span several lines or appear inline:

Visible text. <!-- A note to the author. --> More visible text.

<!--
## Draft section
{{ vis ref: /u/example/p/draft }}
-->

{/*
This section is temporarily disabled.
{{ image ref: draft.png }}
*/}

Visible {/* hidden */} text.

Everything inside a comment is ignored before Markdown and Novem blocks are parsed. Commented headings, page breaks, embeds, and variables produce no output, references or diagnostics. A comment does not introduce a blank page or extra spacing.

Rules

  • Comments do not nest. The first matching closer ends the comment: --> for HTML, or */} for JSX. Other comment markers inside it are hidden text.
  • An unclosed comment hides the rest of the content.
  • Markers inside inline code or fenced code blocks remain literal examples.
  • A comment surrounding a code fence hides the fence and its contents.
`<!-- This is visible code. -->`

```markdown
{/* This is also visible code. */}
```

The existing {{/* / */}} block form also remains supported, with each marker alone on its own line:

{{/*
Hidden content.
*/}}
Next
Preview