{note}

{note} Make sure to do X, Y and Z before emailing this snippet out! {endnote}

Dear Colleague...

Setting Name	Type	Description
insert	yes/no	Whether to include when inserted (defaults to `no`)
preview	yes/no	Whether to include in snippet previews (defaults to `yes`)
General Command Settings
trim	yes/no/left/right	If `yes` whitespace is removed before and after the command. If `left`, only whitespace to the left is removed. If `right`, only whitespace to the right is removed.

The note command can be used to display instructions or information you do not want to show up in the final inserted snippet.

By default, the contents of a note are shown in the snippet's preview, but are not inserted as part of the snippet.

For example, this can be useful if you're sharing a snippet folder with your team and need to document what's happening in the snippet.

To also hide the note contents in the snippet's preview, set the preview setting to no.

A note on whitespace

The note command does not output anything, but it still takes up whitespace in your snippet.

The optional trim setting is useful for removing whitespace around the command.

See the whitespace guide for more information on why this happens in Text Blaze.