Skip to content

Commit

Permalink
Add illustration of Admonition types (#836)
Browse files Browse the repository at this point in the history
Co-authored-by: Eric Arellano <[email protected]>
  • Loading branch information
beckykd and Eric-Arellano authored Feb 19, 2024
1 parent 3be11a8 commit 949d92f
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,8 @@ To use an `Admonition`, use the following syntax
<Admonition type="note">This is a __note__ example</Admonition>
```

Available types are `note, tip, info, caution, danger`
Available types are `note, tip, info, caution, danger`. This is what they look like:
![types](https://github.com/Qiskit/documentation/assets/66339736/ebf5794e-45eb-49ee-97df-41ff08ee876d)

By default, the title is the `type` capitalized. You can customize it by setting `title`:

Expand Down

0 comments on commit 949d92f

Please sign in to comment.