-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathmkdocs.yml
87 lines (81 loc) · 1.85 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
site_name: MkDocs Placeholder Plugin
repo_url: https://github.com/six-two/mkdocs-placeholder-plugin
repo_name: mkdocs-placeholder-plugin
theme:
name: material
# name: mkdocs
# name: readthedocs
palette:
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: green
toggle:
icon: material/brightness-4
name: Switch to light mode
icon:
repo: fontawesome/brands/github
features:
- navigation.sections
- content.code.copy
- navigation.footer
# For testing issue 7
- navigation.instant
plugins:
- placeholder:
placeholder_extra_js: placeholder-extra.js
- badges
- search
- git-revision-date-localized
# - spellcheck:
# known_words: ../known_words.txt
# ignore_code: yes
nav:
- index.md
- usage.md
- demo.md
- configuration.md
- advanced-usage.md
- replace-modes.md
- validators.md
- themes.md
- "Tests":
- tests/basic.md
- tests/auto-tables.md
- tests/auto-table-empty.md
- tests/mermaid_diagrams.md
- tests/validators.md
- tests/new-ts-code.md
extra_javascript:
- development-warning.js
markdown_extensions:
# Message/error/warning boxes
- admonition
- pymdownx.details
# Different formatting options
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
# For search exclusion
- attr_list
# For mermaid diagrams
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# for tabs
- pymdownx.tabbed:
alternate_style: true
# For MkDocs 1.5 do not warn me about absolute links or `iLINKi`
validation:
absolute_links: ignore
unrecognized_links: ignore
watch:
- placeholder-plugin.yaml