Skip to content

Commit 3f8a057

Browse files
committed
Updated upgrade guide
1 parent 1316d8d commit 3f8a057

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/upgrade.md

+32
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,38 @@ viewports]:
6666
[Tabbed]: setup/extensions/python-markdown-extensions.md#tabbed
6767
[better behavior on mobile viewports]: https://twitter.com/squidfunk/status/1424740370596958214
6868

69+
#### `pymdownx.superfences`
70+
71+
The `*-experimental` suffix must be removed from the [custom fence][SuperFences]
72+
class property, which is used to target code blocks to be rendered as [diagrams]
73+
using [Mermaid.js]:
74+
75+
=== "8.x"
76+
77+
``` yaml
78+
markdown_extensions:
79+
- pymdownx.superfences:
80+
custom_fences:
81+
- name: mermaid
82+
class: mermaid
83+
format: !!python/name:pymdownx.superfences.fence_code_format
84+
```
85+
86+
=== "7.x"
87+
88+
``` yaml
89+
markdown_extensions:
90+
- pymdownx.superfences:
91+
custom_fences:
92+
- name: mermaid
93+
class: mermaid-experimental
94+
format: !!python/name:pymdownx.superfences.fence_code_format
95+
```
96+
97+
[SuperFences]: setup/extensions/python-markdown-extensions.md#superfences
98+
[diagrams]: reference/diagrams.md
99+
[Mermaid.js]: https://mermaid-js.github.io/mermaid/
100+
69101
#### `google_analytics`
70102

71103
This option was [deprecated in MkDocs 1.2.0], as the implementation of a

0 commit comments

Comments
 (0)