Skip to content

Commit 4cf5db4

Browse files
authored
Add figure component to MDX guide (#3719)
We added this recently to avoid using blockquotes everywhere.
1 parent ca9dcb5 commit 4cf5db4

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

mdx-guide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,20 @@ We also have a specialized admonition for Qiskit Code Assistant prompt suggestio
195195
/>
196196
```
197197

198+
### Figures
199+
200+
Use this component for proofs, theorems, definitions, or anything that is
201+
referenced in the main flow of the document, but could be moved to another part
202+
of the document without affecting the main flow.
203+
204+
To insert a figure, use the following syntax.
205+
206+
```mdx
207+
<Figure title="Proof">
208+
You can use any MDX inside a figure.
209+
</Figure>
210+
```
211+
198212
### Definition Tooltip
199213

200214
To use a `DefinitionTooltip`, use the following syntax:

0 commit comments

Comments
 (0)