Skip to content

Commit cc1839a

Browse files
committed
[ENH] add several mkdocs features
1 parent d384137 commit cc1839a

File tree

1 file changed

+44
-7
lines changed

1 file changed

+44
-7
lines changed

mkdocs.yml

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ repo_url: https://github.com/bids-standard/bids-website/tree/main
44
site_url: https://bids.neuroimaging.io/
55

66
plugins:
7-
- search
7+
- search:
8+
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
89
- tags
910
# - social
1011
- blog
@@ -192,20 +193,25 @@ theme:
192193
features:
193194
- announce.dismiss
194195
- content.action.edit
196+
- content.code.annotate
195197
- content.code.copy
196198
- content.tabs.link
197199
- content.tooltips
198-
- footnotes
199200
- header.autohide
201+
- navigation.expand
200202
- navigation.footer
201203
- navigation.indexes
202204
- navigation.instant
205+
- navigation.instant.progress
206+
- navigation.prune
203207
- navigation.sections
204208
- navigation.tabs
205209
- navigation.tabs.sticky
206210
- navigation.top
207-
- search.suggest
211+
- navigation.tracking
208212
- search.highlight
213+
- search.share
214+
- search.suggest
209215
- toc.follow
210216
icon:
211217
repo: fontawesome/brands/github
@@ -217,15 +223,15 @@ theme:
217223
icon: material/brightness-auto
218224
name: Switch to light mode
219225
- media: "(prefers-color-scheme: light)"
220-
primary: teal
221-
accent: green
226+
primary: custom
227+
accent: custom
222228
scheme: default
223229
toggle:
224230
icon: material/brightness-7
225231
name: Switch to dark mode
226232
- media: "(prefers-color-scheme: dark)"
227-
primary: teal
228-
accent: green
233+
primary: custom
234+
accent: custom
229235
scheme: slate
230236
toggle:
231237
icon: material/brightness-4
@@ -237,29 +243,60 @@ markdown_extensions:
237243
- abbr
238244
- admonition
239245
- attr_list
246+
- def_list
247+
- footnotes
240248
- md_in_html
249+
- pymdownx.arithmatex:
250+
generic: true
251+
- pymdownx.betterem:
252+
smart_enable: all
253+
- pymdownx.caret
241254
- pymdownx.details
242255
- pymdownx.emoji:
243256
emoji_generator: !!python/name:material.extensions.emoji.to_svg
244257
emoji_index: !!python/name:material.extensions.emoji.twemoji
245258
- pymdownx.snippets:
246259
auto_append:
247260
- includes/abbreviations.md
261+
- pymdownx.highlight:
262+
anchor_linenums: true
263+
line_spans: __span
264+
pygments_lang_class: true
265+
- pymdownx.inlinehilite
266+
- pymdownx.keys
267+
- pymdownx.magiclink:
268+
normalize_issue_symbols: true
269+
repo_url_shorthand: true
270+
user: bids-standard
271+
repo: bids-website
272+
- pymdownx.mark
273+
- pymdownx.smartsymbols
248274
- pymdownx.superfences:
249275
custom_fences:
250276
- name: mermaid
251277
class: mermaid
252278
format: !!python/name:pymdownx.superfences.fence_code_format
253279
- pymdownx.tabbed:
254280
alternate_style: true
281+
combine_header_slug: true
282+
slugify: !!python/object/apply:pymdownx.slugs.slugify
283+
kwds:
284+
case: lower
285+
- pymdownx.tasklist:
286+
custom_checkbox: true
287+
- pymdownx.tilde
255288
- tables
256289
- toc:
290+
permalink: true
257291
anchorlink: true
258292
toc_depth: 3
259293

260294
extra_javascript:
261295
- https://unpkg.com/[email protected]/dist/tablesort.min.js
262296
- javascripts/tablesort.js
297+
- javascripts/mathjax.js
298+
- https://polyfill.io/v3/polyfill.min.js?features=es6
299+
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
263300

264301
extra_css:
265302
- stylesheets/extra.css

0 commit comments

Comments
 (0)