forked from hyperledger-labs/documentation-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
111 lines (111 loc) · 2.98 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
101
102
103
104
105
106
107
108
109
110
111
site_name: Hyperledger Caliper documentation platform update
repo_name: hyperledger-labs/documentation-template
repo_url: https://github.com/anushatomar13/documentation-template
theme:
name: material
custom_dir: overrides
logo: assets/project-logo.png
favicon: assets/project-icon.png
icon:
repo: fontawesome/brands/github
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.code.copy
- navigation.expand
- navigation.footer
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- toc.follow
- toc.integrate
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
toc_depth: 3
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:materialx.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
- search
- mike
extra:
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
version:
provider: mike
nav:
- Introduction: index.md
- Concepts:
- Concept 1: concepts/concept-1.md
- Concept 2: concepts/concept-2.md
- Concept 3: concepts/concept-3.md
- Getting Started:
- Installation: getting-started/installation.md
- Running: getting-started/running.md
- Tutorials:
- Introduction: tutorials/index.md
- Tutorial 1: tutorials/tutorial-1.md
- Tutorial 2: tutorials/tutorial-2.md
- Tutorial 3: tutorials/tutorial-3.md
- Guides:
- Operations: guides/operations.md
- Developers: guides/developers.md
- Upgrading: guides/upgrading.md
- References:
- Architecture: references/architecture.md
- Commands: references/commands.md
- Roadmap: references/roadmap.md
- Contributing:
- How to Contribute: contributing/how-to-contribute.md
- Reporting a Bug: contributing/reporting-a-bug.md
- Requesting a Change: contributing/requesting-a-change.md
- Asking a Question: contributing/asking-a-question.md
- FAQs: faqs.md
- Glossary: glossary.md