@@ -52,13 +52,11 @@ theme:
52
52
1. Set `<type`> to any of the [supported types] and `<icon>` to any valid icon
53
53
shortcode, which you can find by using the [icon search].
54
54
55
- ??? example "Example : using alternative icon sets"
55
+ ??? example "Expand to show alternate icon sets"
56
56
57
57
=== ":octicons-mark-github-16 : Octicons"
58
58
59
- _Example_ :
60
-
61
- ` ` ` yaml
59
+ ` ` ` yaml title="Admonition with alternate icon set"
62
60
theme:
63
61
icon:
64
62
admonition:
@@ -76,16 +74,16 @@ theme:
76
74
quote: octicons/quote-16
77
75
` ` `
78
76
79
- _Result_ :
77
+ <div class="result" markdown>
80
78
81
79
[![Octicons]][Octicons]
82
80
81
+ </div>
83
82
84
- === ":fontawesome-brands-font-awesome : FontAwesome"
85
83
86
- _Example_ :
84
+ === ":fontawesome-brands-font-awesome : FontAwesome"
87
85
88
- ` ` ` yaml
86
+ ` ` ` yaml title="Admonition with alternate icon set"
89
87
theme:
90
88
icon:
91
89
admonition:
@@ -103,10 +101,12 @@ theme:
103
101
quote: fontawesome/solid/quote-left
104
102
` ` `
105
103
106
- _Result_ :
104
+ <div class="result" markdown>
107
105
108
106
[![FontAwesome]][FontAwesome]
109
107
108
+ </div>
109
+
110
110
[Insiders] : ../insiders/index.md
111
111
[custom icon] : icons-emojis.md#additional-icons
112
112
[supported types] : # supported-types
@@ -118,136 +118,134 @@ theme:
118
118
119
119
Admonitions follow a simple syntax : a block starts with `!!!`, followed by a
120
120
single keyword used as a [type qualifier]. The content of the block follows on
121
- the next line, indented by four spaces.
121
+ the next line, indented by four spaces :
122
122
123
- _Example_ :
124
-
125
- ` ` ` markdown
123
+ ` ` ` markdown title="Admonition"
126
124
!!! note
127
125
128
126
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
129
127
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
130
128
massa, nec semper lorem quam in massa.
131
129
` ` `
132
130
133
- _Result_ :
131
+ <div class="result" markdown>
134
132
135
133
!!! note
136
134
137
135
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
138
136
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
139
137
massa, nec semper lorem quam in massa.
140
138
139
+ </div>
140
+
141
141
[type qualifier] : # supported-types
142
142
143
143
# ## Changing the title
144
144
145
145
By default, the title will equal the type qualifier in titlecase. However, it
146
146
can be changed by adding a quoted string containing valid Markdown (including
147
- links, formatting, ...) after the type qualifier.
147
+ links, formatting, ...) after the type qualifier :
148
148
149
- _Example_ :
150
-
151
- ` ` ` markdown
149
+ ` ` ` markdown title="Admonition with custom title"
152
150
!!! note "Phasellus posuere in sem ut cursus"
153
151
154
152
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
155
153
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
156
154
massa, nec semper lorem quam in massa.
157
155
` ` `
158
156
159
- _Result_ :
157
+ <div class="result" markdown>
160
158
161
159
!!! note "Phasellus posuere in sem ut cursus"
162
160
163
161
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
164
162
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
165
163
massa, nec semper lorem quam in massa.
166
164
165
+ </div>
166
+
167
167
# ## Removing the title
168
168
169
169
Similar to [changing the title], the icon and title can be omitted entirely by
170
170
adding an empty string directly after the type qualifier. Note that this will
171
- not work for [collapsible blocks].
171
+ not work for [collapsible blocks] :
172
172
173
- _Example_ :
174
-
175
- ` ` ` markdown
173
+ ` ` ` markdown title="Admonition without title"
176
174
!!! note ""
177
175
178
176
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
179
177
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
180
178
massa, nec semper lorem quam in massa.
181
179
` ` `
182
180
183
- _Result_ :
181
+ <div class="result" markdown>
184
182
185
183
!!! note ""
186
184
187
185
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
188
186
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
189
187
massa, nec semper lorem quam in massa.
190
188
189
+ </div>
190
+
191
191
[changing the title] : # changing-the-title
192
192
[collapsible blocks] : # collapsible-blocks
193
193
194
194
# ## Collapsible blocks
195
195
196
196
When [Details] is enabled and an admonition block is started with `???` instead
197
197
of `!!!`, the admonition is rendered as a collapsible block with a small toggle
198
- on the right side.
198
+ on the right side :
199
199
200
- _Example_ :
201
-
202
- ` ` ` markdown
200
+ ` ` ` markdown title="Admonition, collapsible"
203
201
??? note
204
202
205
203
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
206
204
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
207
205
massa, nec semper lorem quam in massa.
208
206
` ` `
209
207
210
- _Result_ :
208
+ <div class="result" markdown>
211
209
212
210
??? note
213
211
214
212
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
215
213
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
216
214
massa, nec semper lorem quam in massa.
217
215
218
- Adding a `+` after the `???` token will render the block as open.
216
+ </div>
219
217
220
- _Example_ :
218
+ Adding a `+` after the `???` token renders the block expanded :
221
219
222
- ` ` ` markdown
220
+ ` ` ` markdown title="Admonition, collapsible and initially expanded"
223
221
???+ note
224
222
225
223
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
226
224
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
227
225
massa, nec semper lorem quam in massa.
228
226
` ` `
229
227
230
- _Result_ :
228
+ <div class="result" markdown>
231
229
232
230
???+ note
233
231
234
232
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
235
233
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
236
234
massa, nec semper lorem quam in massa.
237
235
236
+ </div>
237
+
238
238
# ## Inline blocks
239
239
240
240
[:octicons-tag-24 : 7.0.0][Inline support] ·
241
241
:octicons-beaker-24 : Experimental
242
242
243
243
Admonitions can also be rendered as inline blocks (i.e. for sidebars), placing
244
244
them to the right using the `inline` + `end` modifiers, or to the left using
245
- only the `inline` modifier.
245
+ only the `inline` modifier :
246
246
247
247
=== ":octicons-arrow-right-16 : inline end"
248
248
249
- _Example_ / _Result_ :
250
-
251
249
!!! info inline end
252
250
253
251
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et
@@ -268,8 +266,6 @@ only the `inline` modifier.
268
266
269
267
=== ":octicons-arrow-left-16 : inline"
270
268
271
- _Example_ / _Result_ :
272
-
273
269
!!! info inline
274
270
275
271
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et
@@ -425,18 +421,6 @@ and add the following CSS to an [additional style sheet]:
425
421
}
426
422
</style>
427
423
428
- _Example_ :
429
-
430
- === ":octicons-file-code-16 : docs/example.md"
431
-
432
- ` ` ` markdown
433
- !!! pied-piper "Pied Piper"
434
-
435
- Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et
436
- euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
437
- purus auctor massa, nec semper lorem quam in massa.
438
- ` ` `
439
-
440
424
=== ":octicons-file-code-16 : docs/stylesheets/extra.css"
441
425
442
426
` ` ` css
@@ -467,13 +451,25 @@ _Example_:
467
451
- stylesheets/extra.css
468
452
` ` `
469
453
470
- _Result_ :
454
+ After applying the customization, you can use the custom admonition type :
455
+
456
+ ` ` ` markdown title="Admonition with custom type"
457
+ !!! pied-piper "Pied Piper"
458
+
459
+ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et
460
+ euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
461
+ purus auctor massa, nec semper lorem quam in massa.
462
+ ` ` `
463
+
464
+ <div class="result" markdown>
471
465
472
466
!!! pied-piper "Pied Piper"
473
467
474
468
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
475
469
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
476
470
massa, nec semper lorem quam in massa.
477
471
472
+ </div>
473
+
478
474
[custom icons] : https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons
479
475
[additional style sheet] : ../customization.md#additional-css
0 commit comments