Skip to content

Commit 58a8de1

Browse files
authored
Add Details to palette examples (#191)
* update to match pymdownx extension page / mkdocs * link to pymdownx page * formatting * add details snippet to the pallete examples * moved buttons lower on example page
1 parent ee44ed8 commit 58a8de1

File tree

4 files changed

+24
-4
lines changed

4 files changed

+24
-4
lines changed

documentation/docs/configuration/extensions/pymdown-extensions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,9 @@ markdown_extensions:
131131
[extra_css MkDocs feature]: https://www.mkdocs.org/user-guide/configuration/#extra_css
132132

133133
See reference for usage:
134+
134135
- [Adding Details]
136+
135137
[Adding Details]: ../../../elements/details
136138

137139
# Credit

documentation/docs/elements/details.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Details setup
22

3-
Enabling detail blocks requires the `pymdown.blocks.details` extension. Add it to the `markdown_extensions` configuration in `mkdocs.yml`:
3+
Enabling detail blocks requires the [pymdown.blocks.details extension]. Add it to the `markdown_extensions` configuration in `mkdocs.yml`:
44

55
```yaml
66
markdown_extensions:
@@ -10,13 +10,15 @@ markdown_extensions:
1010
class: terminal-alert
1111
title: Info
1212
- name: warn
13-
class: terminal-alert terminal-alert-error
13+
class: 'terminal-alert terminal-alert-error'
1414
title: Warning
1515
- name: important
16-
class: terminal-alert terminal-alert-primary
16+
class: 'terminal-alert terminal-alert-primary'
1717
title: Important
1818
```
1919
20+
[pymdown.blocks.details extension]: ../../configuration/extensions/pymdown-extensions/#details
21+
2022
# Example
2123
2224
/// info
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Details Example
2+
3+
/// info
4+
This is an info block
5+
///
6+
7+
/// warning
8+
This is a warning
9+
///
10+
11+
/// important
12+
This is important
13+
///
14+
15+
<br>
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
--8<--
22
elements/examples/typography.md
33
elements/examples/code.md
4-
elements/examples/buttons.md
4+
elements/examples/details.md
55
elements/examples/table.md
66
elements/examples/footnotes.md
77
elements/examples/links.md
@@ -10,4 +10,5 @@ elements/examples/figure.md
1010
elements/examples/definitions.md
1111
elements/examples/blockquotes.md
1212
elements/examples/tooltips.md
13+
elements/examples/buttons.md
1314
--8<--

0 commit comments

Comments
 (0)