Internal documentation only

This page has been marked as a draft.

Add comments

You may want to add comments or ’null’ content that should not be included in the output pages.

However, markdown does not currently include a native way to do this. This has been an ongoing discussion between maintainers and the community and changes may occur in the future. We use the CommonMark standard for markdown, their website contains a useful discussion of markdown governance and a full language specification.

For now we can add comments using a hack of the markdown link syntax.

To add a single line comment either:


[//]: # (This may be the most platform independent comment)

[a short comment]:#

In fact I’ll include them here, try to spot them!

You can also add multi-line comments that can be used to null sections of content:

[//]: # (the quick
brown fox 
jumped over the
 lazy dog)
Note: For a detailed discussion, see this thread.
["Obcerv"] ["User Guide"]

Was this topic helpful?