Skip to content

Commit 50408bf

Browse files
committed
Added new code block styles to reference documentation
1 parent ca1996b commit 50408bf

21 files changed

+376
-453
lines changed

docs/reference/abbreviations.md

+6-12
Original file line numberDiff line numberDiff line change
@@ -36,40 +36,38 @@ See additional configuration options:
3636
3737
Abbreviations can be defined by using a special syntax similar to URLs and
3838
[footnotes], starting with a `*` and immediately followed by the term or
39-
acronym to be associated in square brackets.
39+
acronym to be associated in square brackets:
4040

41-
_Example_:
42-
43-
``` markdown
41+
``` markdown title="Text with abbreviations"
4442
The HTML specification is maintained by the W3C.
4543
4644
*[HTML]: Hyper Text Markup Language
4745
*[W3C]: World Wide Web Consortium
4846
```
4947

50-
_Result_:
48+
<div class="result" markdown>
5149

5250
The HTML specification is maintained by the W3C.
5351

5452
*[HTML]: Hyper Text Markup Language
5553
*[W3C]: World Wide Web Consortium
5654

55+
</div>
56+
5757
[footnotes]: footnotes.md
5858

5959
### Adding a glossary
6060

6161
The [Snippets] extension can be used to implement a simple glossary by moving
6262
all abbreviations in a dedicated file[^1], and embedding it with the
63-
[`--8<--` notation][Snippets notation] at the end of each document.
63+
[`--8<--` notation][Snippets notation] at the end of each document:
6464

6565
[^1]:
6666
It's highly recommended to put the Markdown file containing the
6767
abbreviations outside of the `docs` folder (here, a folder with the name
6868
`includes` is used), as MkDocs might otherwise complain about an
6969
unreferenced file.
7070

71-
_Example_:
72-
7371
=== ":octicons-file-code-16: docs/example.md"
7472

7573
```` markdown
@@ -85,8 +83,4 @@ _Example_:
8583
*[W3C]: World Wide Web Consortium
8684
````
8785

88-
_Result_:
89-
90-
The HTML specification is maintained by the W3C.
91-
9286
[Snippets notation]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#snippets-notation

docs/reference/admonitions.md

+47-51
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,11 @@ theme:
5252
1. Set `<type`> to any of the [supported types] and `<icon>` to any valid icon
5353
shortcode, which you can find by using the [icon search].
5454

55-
??? example "Example: using alternative icon sets"
55+
??? example "Expand to show alternate icon sets"
5656

5757
=== ":octicons-mark-github-16: Octicons"
5858

59-
_Example_:
60-
61-
``` yaml
59+
``` yaml title="Admonition with alternate icon set"
6260
theme:
6361
icon:
6462
admonition:
@@ -76,16 +74,16 @@ theme:
7674
quote: octicons/quote-16
7775
```
7876

79-
_Result_:
77+
<div class="result" markdown>
8078

8179
[![Octicons]][Octicons]
8280

81+
</div>
8382

84-
=== ":fontawesome-brands-font-awesome: FontAwesome"
8583

86-
_Example_:
84+
=== ":fontawesome-brands-font-awesome: FontAwesome"
8785

88-
``` yaml
86+
``` yaml title="Admonition with alternate icon set"
8987
theme:
9088
icon:
9189
admonition:
@@ -103,10 +101,12 @@ theme:
103101
quote: fontawesome/solid/quote-left
104102
```
105103

106-
_Result_:
104+
<div class="result" markdown>
107105

108106
[![FontAwesome]][FontAwesome]
109107

108+
</div>
109+
110110
[Insiders]: ../insiders/index.md
111111
[custom icon]: icons-emojis.md#additional-icons
112112
[supported types]: #supported-types
@@ -118,136 +118,134 @@ theme:
118118

119119
Admonitions follow a simple syntax: a block starts with `!!!`, followed by a
120120
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:
122122

123-
_Example_:
124-
125-
``` markdown
123+
``` markdown title="Admonition"
126124
!!! note
127125
128126
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
129127
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
130128
massa, nec semper lorem quam in massa.
131129
```
132130

133-
_Result_:
131+
<div class="result" markdown>
134132

135133
!!! note
136134

137135
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
138136
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
139137
massa, nec semper lorem quam in massa.
140138

139+
</div>
140+
141141
[type qualifier]: #supported-types
142142

143143
### Changing the title
144144

145145
By default, the title will equal the type qualifier in titlecase. However, it
146146
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:
148148

149-
_Example_:
150-
151-
``` markdown
149+
``` markdown title="Admonition with custom title"
152150
!!! note "Phasellus posuere in sem ut cursus"
153151
154152
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
155153
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
156154
massa, nec semper lorem quam in massa.
157155
```
158156

159-
_Result_:
157+
<div class="result" markdown>
160158

161159
!!! note "Phasellus posuere in sem ut cursus"
162160

163161
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
164162
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
165163
massa, nec semper lorem quam in massa.
166164

165+
</div>
166+
167167
### Removing the title
168168

169169
Similar to [changing the title], the icon and title can be omitted entirely by
170170
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]:
172172

173-
_Example_:
174-
175-
``` markdown
173+
``` markdown title="Admonition without title"
176174
!!! note ""
177175
178176
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
179177
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
180178
massa, nec semper lorem quam in massa.
181179
```
182180

183-
_Result_:
181+
<div class="result" markdown>
184182

185183
!!! note ""
186184

187185
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
188186
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
189187
massa, nec semper lorem quam in massa.
190188

189+
</div>
190+
191191
[changing the title]: #changing-the-title
192192
[collapsible blocks]: #collapsible-blocks
193193

194194
### Collapsible blocks
195195

196196
When [Details] is enabled and an admonition block is started with `???` instead
197197
of `!!!`, the admonition is rendered as a collapsible block with a small toggle
198-
on the right side.
198+
on the right side:
199199

200-
_Example_:
201-
202-
``` markdown
200+
``` markdown title="Admonition, collapsible"
203201
??? note
204202
205203
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
206204
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
207205
massa, nec semper lorem quam in massa.
208206
```
209207

210-
_Result_:
208+
<div class="result" markdown>
211209

212210
??? note
213211

214212
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
215213
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
216214
massa, nec semper lorem quam in massa.
217215

218-
Adding a `+` after the `???` token will render the block as open.
216+
</div>
219217

220-
_Example_:
218+
Adding a `+` after the `???` token renders the block expanded:
221219

222-
``` markdown
220+
``` markdown title="Admonition, collapsible and initially expanded"
223221
???+ note
224222
225223
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
226224
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
227225
massa, nec semper lorem quam in massa.
228226
```
229227

230-
_Result_:
228+
<div class="result" markdown>
231229

232230
???+ note
233231

234232
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
235233
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
236234
massa, nec semper lorem quam in massa.
237235

236+
</div>
237+
238238
### Inline blocks
239239

240240
[:octicons-tag-24: 7.0.0][Inline support] ·
241241
:octicons-beaker-24: Experimental
242242

243243
Admonitions can also be rendered as inline blocks (i.e. for sidebars), placing
244244
them to the right using the `inline` + `end` modifiers, or to the left using
245-
only the `inline` modifier.
245+
only the `inline` modifier:
246246

247247
=== ":octicons-arrow-right-16: inline end"
248248

249-
_Example_ / _Result_:
250-
251249
!!! info inline end
252250

253251
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et
@@ -268,8 +266,6 @@ only the `inline` modifier.
268266

269267
=== ":octicons-arrow-left-16: inline"
270268

271-
_Example_ / _Result_:
272-
273269
!!! info inline
274270

275271
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et
@@ -425,18 +421,6 @@ and add the following CSS to an [additional style sheet]:
425421
}
426422
</style>
427423

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-
440424
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
441425

442426
``` css
@@ -467,13 +451,25 @@ _Example_:
467451
- stylesheets/extra.css
468452
```
469453

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>
471465

472466
!!! pied-piper "Pied Piper"
473467

474468
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
475469
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
476470
massa, nec semper lorem quam in massa.
477471

472+
</div>
473+
478474
[custom icons]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons
479475
[additional style sheet]: ../customization.md#additional-css

docs/reference/buttons.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,16 @@ In order to render a link as a button, suffix it with curly braces and add the
3434
`.md-button` class selector to it. The button will receive the selected
3535
[primary color] and [accent color] if active.
3636

37-
_Example_:
38-
39-
``` markdown
37+
``` markdown title="Button"
4038
[Subscribe to our newsletter](#){ .md-button }
4139
```
4240

43-
_Result_:
41+
<div class="result" markdown>
4442

4543
[Subscribe to our newsletter][Demo]{ .md-button }
4644

45+
</div>
46+
4747
[primary color]: ../setup/changing-the-colors.md#primary-color
4848
[accent color]: ../setup/changing-the-colors.md#accent-color
4949
[Demo]: javascript:alert$.next("Demo")
@@ -54,32 +54,32 @@ If you want to display a filled, primary button (like on the [landing page]
5454
of Material for MkDocs), add both, the `.md-button` and `.md-button--primary`
5555
CSS class selectors.
5656

57-
_Example_:
58-
59-
``` markdown
57+
``` markdown title="Button, primary"
6058
[Subscribe to our newsletter](#){ .md-button .md-button--primary }
6159
```
6260

63-
_Result_:
61+
<div class="result" markdown>
6462

6563
[Subscribe to our newsletter][Demo]{ .md-button .md-button--primary }
6664

65+
</div>
66+
6767
[landing page]: ../index.md
6868

6969
### Adding icon buttons
7070

7171
Of course, icons can be added to all types of buttons by using the [icon syntax]
7272
together with any valid icon shortcode, which can be easily found with a few keystrokes through the [icon search].
7373

74-
_Example_:
75-
76-
``` markdown
77-
[Send :fontawesome-solid-paper-plane:](#){ .md-button .md-button--primary }
74+
``` markdown title="Button with icon"
75+
[Send :fontawesome-solid-paper-plane:](#){ .md-button }
7876
```
7977

80-
_Result_:
78+
<div class="result" markdown>
79+
80+
[Send :fontawesome-solid-paper-plane:][Demo]{ .md-button }
8181

82-
[Send :fontawesome-solid-paper-plane:][Demo]{ .md-button .md-button--primary }
82+
</div>
8383

8484
[icon syntax]: icons-emojis.md#using-icons
8585
[icon search]: icons-emojis.md#search

0 commit comments

Comments
 (0)