Skip to content

Commit c3b8b01

Browse files
authored
new entries in PyMdown Extension docs
adds blurbs for - superfences - highlight - inlinehilite
1 parent ec2f075 commit c3b8b01

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,37 @@ See reference for usage:
6363

6464
[Adding Snippets]: ./snippets.md
6565

66+
## SuperFences
67+
68+
The [SuperFences] extension allows fenced blocks to be nested inside block quotes, lists, or other block elements. Enable it via `mkdocs.yml`:
69+
70+
```yaml
71+
markdown_extensions:
72+
- pymdownx.superfences
73+
```
74+
75+
This extension is incompatible with the Python Markdown extension `markdown.extensions.fenced_code`.
76+
77+
[SuperFences]: https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
78+
79+
## Highlight and InlineHilite
80+
81+
The [Highlight] and [InlineHilite] extensions can be used to highlight code blocks. If used with the [PyMdown SuperFences](#superfences) extension line numbers can be added as well. Enable them via `mkdocs.yml`:
82+
83+
```yaml
84+
markdown_extensions:
85+
- pymdownx.superfences
86+
- pymdownx.highlight
87+
- pymdownx.inlinehilite
88+
```
89+
90+
See reference for recommended configuration options:
91+
92+
- [Code Highlighting > PyMdown and Pygments](../code-highlighting/index.md#pymdown-and-pygments)
93+
94+
[Highlight]: https://facelessuser.github.io/pymdown-extensions/extensions/highlight/
95+
[InlineHilite]: https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/
96+
6697

6798
# Credit
6899

0 commit comments

Comments
 (0)