Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 DOCS: Fix admonition example #904

Merged
merged 2 commits into from
Apr 11, 2024
Merged

📚 DOCS: Fix admonition example #904

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71b9c79
Fix an admonition example (#902)
Apr 10, 2024
225b8e7
Merge branch 'master' into bugfix-admonition-class-example
chrisjsewell Apr 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/syntax/admonitions.md
View file
Open in desktop
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