Skip to content

Commit

Permalink
📚 DOCS: Fix admonition example (#904)
Browse files Browse the repository at this point in the history
Co-authored-by: Russell <N9TIP3pXBdSpBL8BUTtS@gmail.com>
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
  • Loading branch information
3 people authored Apr 11, 2024
1 parent 10c2003 commit e830cba
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/syntax/admonitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ The following core admonition types are available:

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

:class: A space-separated list of CSS classes to add to the admonition.
:class: A space-separated list of CSS classes to add to the admonition, conforming to the [identifier normalization rules](https://docutils.sourceforge.io/docs/ref/rst/directives.html#identifier-normalization).
:name: A reference target for the admonition (see [cross-referencing](#syntax/referencing)).

::::{myst-example}

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

0 comments on commit e830cba

Please sign in to comment.