Skip to content

Commit 7c25664

Browse files
committed
docs: enable required mkdocs plugins
We had to use --unsafe in check-yaml so that it checks syntax but does not attempt to load the YAML itself. Otherwise an error gets triggered by the emoji plugin of mkdocs.
1 parent b27ee02 commit 7c25664

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ repos:
1111
- id: check-json
1212
- id: check-toml
1313
- id: check-yaml
14+
args: ['--unsafe']
1415
- id: check-added-large-files
1516

1617
- repo: local

mkdocs.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,19 @@ markdown_extensions:
2424
permalink: true
2525
- pymdownx.magiclink
2626
- def_list
27+
- attr_list
2728
- admonition
29+
- pymdownx.details
30+
- pymdownx.superfences
2831
- pymdownx.highlight:
2932
anchor_linenums: true
3033
- pymdownx.inlinehilite
3134
- pymdownx.snippets
32-
- pymdownx.superfences
35+
- pymdownx.tabbed:
36+
alternate_style: true
37+
- pymdownx.emoji:
38+
emoji_index: !!python/name:material.extensions.emoji.twemoji
39+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
3340

3441
theme:
3542
name: material

0 commit comments

Comments
 (0)