Skip to content

Commit 5d06179

Browse files
committed
βž• πŸ“ add more handy markdown extensions
1 parent 4f16238 commit 5d06179

File tree

3 files changed

+48
-19
lines changed

3 files changed

+48
-19
lines changed

β€Žmkdocs.yml

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,33 @@ plugins:
4444
show_source: false
4545
show_signature_annotations: true
4646

47-
# https://squidfunk.github.io/mkdocs-material/plugins/search/
48-
- search
49-
5047
# https://squidfunk.github.io/mkdocs-material/plugins/privacy/
5148
- privacy:
5249
enabled: !ENV [CI, false]
5350

51+
# https://squidfunk.github.io/mkdocs-material/plugins/search/
52+
- search
53+
5454
markdown_extensions:
5555
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/
5656
- abbr
57-
- admonition
5857
- attr_list
5958
- def_list
6059
- footnotes
6160
- md_in_html
6261
- toc:
6362
permalink: "πŸ”—"
6463

64+
# https://github.com/oprypin/markdown-callouts
65+
- callouts
66+
67+
# https://facelessuser.github.io/pymdown-extensions/extensions/betterem/
68+
- pymdownx.betterem:
69+
smart_enable: asterisk
70+
71+
- pymdownx.blocks.tab:
72+
alternate_style: true
73+
6574
# https://facelessuser.github.io/pymdown-extensions/extensions/emoji/
6675
- pymdownx.emoji:
6776
emoji_index: !!python/name:material.extensions.emoji.twemoji
@@ -82,6 +91,24 @@ markdown_extensions:
8291
user: numpy
8392
repo: numtype
8493

94+
# https://facelessuser.github.io/pymdown-extensions/extensions/saneheaders/
95+
- pymdownx.saneheaders
96+
97+
extra:
98+
analytics:
99+
provider: google
100+
property: G-JYJJ7JYLG1
101+
consent:
102+
title: Cookie consent
103+
description: >-
104+
We use cookies to recognize your repeated visits and preferences, as well
105+
as to measure the effectiveness of our documentation and whether users
106+
find what they're searching for. With your consent, you're helping us to
107+
make our documentation better.
108+
109+
extra_css:
110+
- style/theme.css
111+
85112
theme:
86113
name: material
87114
favicon: img/favicon.ico
@@ -126,19 +153,4 @@ theme:
126153
icon: fontawesome/regular/sun
127154
name: Switch to system preference
128155

129-
extra_css:
130-
- style/theme.css
131-
132-
extra:
133-
analytics:
134-
provider: google
135-
property: G-JYJJ7JYLG1
136-
consent:
137-
title: Cookie consent
138-
description: >-
139-
We use cookies to recognize your repeated visits and preferences, as well
140-
as to measure the effectiveness of our documentation and whether users
141-
find what they're searching for. With your consent, you're helping us to
142-
make our documentation better.
143-
144156
copyright: Copyright ©, 2025 NumPy Developers.

β€Žpyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ typecheck = [
8181
docs = [
8282
"mkdocs-material>=9.6.10",
8383
"mkdocs-awesome-nav>=3.1.0",
84+
"markdown-callouts>=0.4.0",
8485
"mkdocs-include-markdown-plugin>=7.1.5",
8586
"mkdocs-minify-plugin>=0.8.0",
8687
"mkdocstrings[python]>=0.29.1",

β€Žuv.lock

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
Β (0)