Admonition Examples¶
This page contains various examples of admonitions with different formatting styles to help identify rendering issues.
Basic Admonitions¶
Standard Format¶
Note
This is a standard note admonition with no title.
Custom Title
This is a warning with a custom title.
With Title But No Extra Spacing¶
Tight Format
This admonition has minimal spacing in the source code.
Alternate Indentation¶
Four Space Indent
This admonition uses exactly four spaces for indentation.
Tab Indent
This admonition uses a tab for indentation instead of spaces.
Nested Content¶
Nested List
This admonition contains a nested list:
- Item 1
- Item 2
- Sub-item A
- Sub-item B
- Item 3
Multi-paragraph Content¶
Multiple Paragraphs
This is the first paragraph in this admonition.
This is the second paragraph. There's a blank line between paragraphs.
This is the third paragraph.
Common Problems¶
No Line Break After Declaration (Typically Fails)¶
!!! danger "No Line Break" This admonition has content on the same line as the declaration, which typically causes rendering issues.
Extra Blank Line (Should Still Work)¶
Extra Blank Line
This admonition has an extra blank line after the declaration, before the content.
Indentation Issues¶
Insufficient Indentation
This content is only indented with 2 spaces, which might cause issues.
Excessive Indentation
This content is indented with 8 spaces, which might be more than necessary.
Security Notice Example¶
Following the exact format that was reported as problematic:
Security Notice
Never share your AMES login credentials with unauthorized personnel. Each person paying invoices should use their own account.
Alternative Formats to Try¶
Try these if standard formats aren't working:
<div class="admonition warning">
<p class="admonition-title">Security Notice</p>
<p>Never share your AMES login credentials with unauthorized personnel. Each person paying invoices should use their own account.</p>
</div>
Or with HTML comments:
!!! warning "Security Notice" Never share your AMES login credentials with unauthorized personnel. Each person paying invoices should use their own account.