You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/syntax/admonitions.md
+20-19Lines changed: 20 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,12 +29,12 @@ Admonitions can span multiple lines and support inline formatting.
29
29
30
30
A relevant piece of information with no serious repercussions if ignored.
31
31
32
-
:::none
33
-
\`\`\`\{note}
32
+
```markdown
33
+
:::{note}
34
34
This is a note.
35
35
It can span multiple lines and supports inline formatting.
36
-
\`\`\`
37
36
:::
37
+
```
38
38
39
39
:::{note}
40
40
This is a note.
@@ -44,11 +44,11 @@ This is a note.
44
44
45
45
You could permanently lose data or leak sensitive information.
46
46
47
-
:::none
48
-
\`\`\`\{caution}
47
+
```markdown
48
+
:::{caution}
49
49
This is a caution.
50
-
\`\`\`
51
50
:::
51
+
```
52
52
53
53
```{caution}
54
54
This is a caution.
@@ -58,11 +58,11 @@ This is a caution.
58
58
59
59
Advice to help users make better choices when using a feature.
60
60
61
-
:::none
62
-
\`\`\`\{tip}
61
+
```markdown
62
+
:::{tip}
63
63
This is a tip.
64
-
\`\`\`
65
64
:::
65
+
```
66
66
67
67
```{tip}
68
68
This is a tip.
@@ -72,11 +72,11 @@ This is a tip.
72
72
73
73
Ignoring this information could impact performance or the stability of your system.
74
74
75
-
:::none
76
-
\`\`\`\{attention}
75
+
```markdown
76
+
:::{attention}
77
77
This is an attention.
78
-
\`\`\`
79
78
:::
79
+
```
80
80
81
81
```{attention}
82
82
This is an attention.
@@ -96,37 +96,38 @@ This is an attention.
96
96
97
97
98
98
**Inline Admonition:**
99
-
:::none
99
+
```none
100
100
NOTE: This is a note.
101
101
It can be multiple lines, but not multiple paragraphs.
102
-
:::
102
+
```
103
103
104
104
**Block Admonition:**
105
-
:::none
105
+
106
+
```none
106
107
[WARNING]
107
108
=======
108
109
This is a warning.
109
110
110
111
It can contain multiple paragraphs.
111
112
=======
112
113
:::
113
-
````
114
+
```
114
115
115
116
`````
116
117
117
118
## Collapsible admonitions
118
119
119
120
You can use `:open: <bool>` to make an admonition collapsible.
120
121
121
-
:::none
122
-
\`\`\`\{note}
122
+
```none
123
+
:::{note}
123
124
:open:
124
125
125
126
Longer content can be collapsed to take less space.
126
127
127
128
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
0 commit comments