-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
50 lines (42 loc) · 1.11 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
site_name: Documentation Template
theme:
name: material
# Include your own logo and favicon
# logo: images/logo.png
# favicon: images/favicon.png
palette:
- scheme: default
primary: teal
accent: teal
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- scheme: slate
primary: teal
accent: teal
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
extra_css:
- stylesheets/extra.css
watch:
# code folders to watch for code changes
- package_a
- package_b
plugins:
- search
- mkdocstrings
- gen-files:
scripts: # for generating reference pages integrated with mkdocstrings
- docs/generate_docs.py
- literate-nav: # for generating the navigation bar
nav_file: navigation.md
- section-index
markdown_extensions:
- tables
# https://squidfunk.github.io/mkdocs-material/reference/diagrams/?h=mermaid
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format