notice

Highlight content to draw attention to it. Use sparingly.

{{< notice note >}}
  This is a note
{{< /notice >}}

The shortcode only takes one position argument, which is the type of notice to display. We currently support two notice types:

• Note
• Tip
• Warning

Also, this shortcode should be used with {{< ... >}} delimiters, as Hugo will otherwise process the full shortcode’s content through Markdown processing, adding extraneous markup.

Examples

Standard Note

{{< notice note >}}
  This product is currently in early availability.
{{< /notice >}}

Renders to:

Note

This product is currently in early availability.

Tip

{{< notice tip >}}
  Here's a useful tip on how to do something!
{{< /notice >}}

Renders to:

Tip

Here’s a useful tip on how to do something!

Warning

{{< notice warning >}}
  Caution: This feature is in beta and may change without warning.
{{< /notice >}}

Renders to:

Warning

Caution: This feature is in beta and may change without warning.

Larger Content Example

Note

Here’s a few things in a big list:

• List item 1
• List item 2
• List item 3
• List item 4
• List item 5

DigitalOcean

Block quote:

This is a single sentence block quote.

This is some much larger block quote content, written in such a way as to extend well beyond a single sentence, so that we cause some sort of word wrap to occur within the browser, as we’d really like to ensure that when this box expands, it doesn’t look as terrible as it possibly could be.

Some inline code: lolcode whatever

Larger code block:

var foo = 3;
console.log(`Value of foo: ${foo}`);