-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
100 lines (96 loc) · 3.69 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
site_name: Med-ImageNet
site_url: https://bhklab.github.io/med-imagenet/
repo_url: https://github.com/bhklab/med-imagenet/
repo_name: bhklab/med-imagenet
markdown_extensions:
- toc:
permalink: "#"
permalink_title: Anchor link to this section for reference
toc_depth: 3
- admonition
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.keys
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight: # from https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
anchor_linenums: true
line_spans: __span
use_pygments: true
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- attr_list
- md_in_html
- footnotes
plugins:
- redirects:
redirect_maps:
"index.md": "Overview/index.md"
- awesome-pages # simplifies configuring page titles and their order
- search # necessary for search functionality to work
- git-authors # adds authors to pages using git history
- autorefs: # automatically link to another page's ref
resolve_closest: true
- git-revision-date-localized: # adds a date to the bottom of each page
enable_creation_date: true
- include-markdown # allows for including Markdown files into another Markdown file
- mike # mike handles versioned documentation
theme:
# logo: assets/bhklab_logo.png
name: material
icon:
annotation: material/plus-circle
repo: fontawesome/brands/github
features:
- header.autohide # hides header when scrolling down
###########################################################################
- content.code.annotate # adds annotations to code blocks
- content.code.copy # adds a copy button to code blocks
- content.code.select # allows selecting text in code blocks
- content.tabs.link # links between tabbed content
- content.tooltips # enables tooltips for additional info
###########################################################################
- navigation.indexes # provides index pages for navigation
- navigation.instant # instant loading of pages
- navigation.instant.prefetch # prefetches pages for instant navigation
- navigation.path # displays path navigation
# - navigation.tabs # adds tab navigation support
- navigation.top # back to top navigation button
- navigation.tracking # tracks page navigation statistics
- navigation.footer # adds a footer to the bottom of the page
###########################################################################
- search.highlight # highlights search terms
- search.suggest # suggests search query completions
- search.share # adds a share button to search results
###########################################################################
- toc.follow # keeps track of the current table of contents entry
font:
text: Red Hat Text
code: JetBrains Mono
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: lime
toggle:
icon: material/weather-night
name: Switch to system preference
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML