Comment Extension
The comment extension provides a mechanism to make comments within markdown text that will not be rendered in the final MooseDocs output. The available configuration items for this extension are provided in Table 1.
Table 1: Configuration items for the comment extension.
Key | Default | Description |
---|---|---|
active | True | Toggle for disabling the extension. This only changes the initial active state, use setActive to control at runtime. |
Inline Comments
In order to create inline, or single-line, comments, the !!
syntax is available. An example of this is shown below in Example 1.
Block Comments
In order to create block, or multi-line, comments, the !!!
syntax is available. An example of this is shown below in Example 2.
warningwarning:HTML-style block comments are not supported
HTML-style comments with the following syntax:
<!-- This is an insightful comment. -->
were previously allowed in MooseDown, but were deprecated in 2019 and finally removed in July 2025. The inline and block comment syntax above should be used going forward.