Admonitions

Tips, notes, and warnings are formatted text blocks for providing useful hints, highlighting potential problems, and informing readers about critical consequences. They are colored and have an icon to the left according to the admonition type.

Use the <tip>, <note>, and <warning> elements to insert corresponding admonition blocks.

In Markdown topics, a blockquote is rendered as a tip by default. But you can change it using the style attribute in curly brackets after the blockquote.

Tip

                <tip>
                    Use a tip to provide optional information or helpful advice,
                    like an alternative way of doing something.
                </tip>
            

                    > Use a tip to provide optional information or helpful advice,
                    > like an alternative way of doing something.
                

Note

                <note>
                    Use a note for important information that the reader should be aware of,
                    like known issues or limitations.
                </note>
            

                    > Use a note for important information that the reader should be aware of,
                    > like known issues or limitations.
                    {style="note"}
                

Warning

                <warning>
                    Use a warning for critical information about potentially harmful consequences,
                    such as damage or data loss.
                </warning>
            

                    > Use a warning for critical information about potentially harmful consequences,
                    > such as damage or data loss.
                    {style="warning"}
                

Last modified: 21 June 2024