Skip to content

Issue on page /syntax/admonitions.html - In example, class should be space separated not comma #902

@72757373656c6c

Description

@72757373656c6c

On the Admonition webpage, in the first section titled "Admonition Types", the example is incorrect.

The text for class is correct, but the example is not. The text says the class is a space separated list, but the example shows a comma separated list.

Text above example and the example

These admonitions take no argument, but may be specified with options:

class:  A space-separated list of CSS classes to add to the admonition. 
name:   A reference target for the admonition (see cross-referencing).

:::{tip}
:class: myclass1,myclass2 
:name: a-tip-reference
Let's give readers a helpful hint!
:::

[Reference to my tip](#a-tip-reference)

HTML Output

Space separated:

<div class="myclass1 myclass2 admonition tip" id="a-tip-reference"

Common separated:

<div class="myclass1-myclass2 admonition tip" id="a-tip-reference">

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions