Hugo Shortcodes Used in Open 3D Engine Documentation

To enrich Open 3D Engine (O3DE) documentation pages with complex elements such as embedded video links and call-outs, use Hugo shortcodes . Markdown doesn’t support these complex elements, but you can write shortcodes in other languages, such as HTML. You can review all currently available shortcodes in the /layouts/shortcodes directory of the O3DE docs repository.

Callout Boxes

O3DE documentation supports three different call-out shortcodes: Note {{< note >}}, Caution {{< caution >}}, and Important {{< important >}}. To use a call-out shortcode, enclose the text that you want to display in the opening and closing shortcode brackets.

Note

Use {{< note >}} to highlight a tip or a piece of information that is helpful to know.

For example:

{{< note >}}
You can *still* use Markdown inside these call-outs.
{{< /note >}}

The output is:

Note:
You can still use Markdown inside these call-outs.

Caution

Use {{< caution >}} to call attention to an important piece of information to avoid pitfalls.

For example:

{{< caution >}}
The call-out style only applies to the line directly above the tag.
{{< /caution >}}

The output is:

Caution:
The call-out style only applies to the line directly above the tag.

Important

Use {{< important >}} to indicate information that is crucial to follow.

For example:

{{< important >}}
Avoid multiple paragraphs in call-outs.
{{< /important >}}

The output is:

Important:
Avoid multiple paragraphs in call-outs.

Call-out boxes in lists

You can use a call-out in a list:

1. Use the note shortcode in a list.
1. A second item with an embedded note.

    {{< note >}}
Warning, Caution, and Note shortcodes, embedded in lists, need to be indented to the level of the list item; four spaces for the first level, eight spaces for the second level, and so on. Lists that contain shortcodes should have newlines between each list item and before and after the shortcode. See [Common Shortcode Issues](#common-shortcode-issues).
{{< /note >}}

1. A third item in a list
1. A fourth item in a list

The output is:

  1. Use the note shortcode in a list

  2. A second item with an embedded note

    Note:
    Warning, Caution, and Note shortcodes, embedded in lists, need to be indented to the level of the list item; four spaces for the first level, eight spaces for the second level, and so on. Lists that contain shortcodes should have newlines between each list item and before and after the shortcode. See Common Shortcode Issues.
  3. A third item in a list

  4. A fourth item in a list


Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.