Admonitions¶

Simple Admonitions¶

!!! abstract "Admonition Title"
    **Indent**{ style="color: teal;" } each line of admonition text with 4 spaces. 
    Admonitions are specially marked "topics" that can appear anywhere an ordinary body 
    element can. They contain arbitrary body elements and `{inline styling}` blocks.
    Typically, an admonition is rendered as an offset block in a document, sometimes outlined or shaded, with a title matching the admonition type.

And this is a regular blockquote, prefixed with >, not an admonition in a box.

!!! note "**Note:**{ style='color: blue;' } Here's an admonition containing only its bold-faced title text all on a single line."
> And this is a regular `blockquote`, prefixed with `>`, not an ***admonition*** in a box.

Collapsible Admonitions¶

Collapsible admonitions show a right-caret icon on the callout box so that the text area can be opened and closed by the user. To make an admonition callout collapsibile, substitute three question marks for the leading exclamation marks: $$$ instead of !!!.

The pymdownx.details extension adds the collapsible option. Enable it in the zensical configuration file:

[project.markdown_extensions]
pymdownx.details = {}

Default closed state¶

??? abstract "This Collapsible Admonition defaults to the closed state."
    **Indent**{ style="color: teal;" } admonition text with 4 spaces. Admonitions are specially marked "topics" that can appear anywhere an ordinary body element can. They contain arbitrary body elements.
    Typically, an admonition is rendered as an offset block in a document, sometimes outlined or shaded, with a title matching the admonition type.

Default opened state¶

Adding a + after the ??? token defaults to the expanded state:

Right-side Inline Callout¶

Admonitions can be rendered as inline blocks (e.g., for sidebars), placing them to the right using the ‘inline end’ modifiers:

!!! info inline end "Right Inline Callout Block"
    Lorem ipsum dolor sit amet, consectetur....

Important: Admonitions that use the inline modifiers must be declared prior to the content block you want to place them beside. If there’s insufficient space to render the admonition next to the block, the admonition will stretch to the full width of the viewport, e.g., on mobile viewports.

Sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa.

Left-side Inline Callout¶

Admonitions can be rendered as inline blocks (e.g., for sidebars), placing them to the left using the ‘inline’ modifier:

!!! info inline "Left Inline Callout Block"
    Lorem ipsum dolor sit amet, consectetur....

Important: Admonitions that use the inline modifiers must be declared prior to the content block you want to place them beside. If there’s insufficient space to render the admonition next to the block, the admonition will stretch to the full width of the viewport, e.g., on mobile viewports.

Sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa.

Admonition Types¶

Advanced Examples¶

Tabs¶

???+ example "Using Tabs in an Admonition"
    === "Unordered list"
        * Sed sagittis eleifend rutrum
        * Donec vitae suscipit est
        * Nulla tempor lobortis orci

    === "Ordered list"
        1. Sed sagittis eleifend rutrum
        2. Donec vitae suscipit est
        3. Nulla tempor lobortis orci

Nested¶

  apache:
    startservers: 2
    maxclients: 2

  apache_startservers: 2
  apache_maxclients: 250

??? example "foldable and nested"
    !!! info "Apache complex nested structure"
        ```yaml
          apache:
            startservers: 2
            maxclients: 2
        ```

    !!! info "Apache simple flat structure"
        ```yaml
          apache_startservers: 2
          apache_maxclients: 250
        ```

GitHub-style callouts¶

This is a regular blockquote, prefixed with > but without a type specification.

A GitHub callout is started with a blockquote marker, >, followed by [!<type>]. The content of the callout follows on subsequent lines, each prefixed with >, like this for a note:

> [!NOTE] **Note:**
> Content `<type>` is case-insensitive.  
> Lines are contiguous unless the preceding line ends with two space characters.

Configuration¶

[project.markdown_extensions.pymdownx.quotes]
callouts = true

Supported callout types¶

Five callout types are supported by GitHub. For three of them a direct mapping exists to the admonition type. The other two, IMPORTANT and CAUTION, use the default admonition icon and styling unless a custom style is added.

With the Quotes extension, any admonition type supported by Zensical can be used, not only these five, for example:
> [!success] *Success* isn't a GitHub callout *type*.

PHP Code Test¶

Found the 'common.php' file.