forked from block-core/documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
173 lines (160 loc) · 4.4 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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
site_name: Blockcore Documentation
site_url: https://docs.blockcore.net
site_description: Blockcore is a platform that enables you to build your own blockchains.
repo_name: documentation
repo_url: https://github.com/block-core/documentation
edit_uri: edit/master/docs/
site_author: Blockcore
copyright: Blockcore / MIT license
extra_javascript:
- https://unpkg.com/mermaid@8.8.3/dist/mermaid.min.js
- _mkdocs/extra_js/custom.js
extra_css:
- _mkdocs/extra_css/custom.css
# change directory names here
docs_dir: docs
site_dir: ./docs_site
theme:
logo: img/logo.png
name: material
custom_dir: docs/_mkdocs/overrides
icon:
repo: fontawesome/brands/github
features:
- content.code.annotate
- navigation.indexes
- navigation.sections
- navigation.tabs
- navigation.instant
- navigation.top
- navigation.tracking
# - navigation.expand
- search.highlight
- search.share
- search.suggest
# - toc.integrate
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
logo: img/logo.png
toggle:
icon: material/weather-night
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: deep purple
logo: img/logo-light.png
toggle:
icon: material/weather-sunny
name: Switch to light mode
markdown_extensions:
- abbr
- def_list
- attr_list #needed to use {:target="_blank"} on links
- pymdownx.snippets:
base_path: docs/_mkdocs/snippets
check_paths: true
- toc:
permalink: false
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
#- meta
- admonition
- pymdownx.highlight:
use_pygments: true
linenums: true
noclasses: false #set to true to enable pygments_style option
pygments_style: 'vs'
- pymdownx.details
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
plugins:
- search
- git-revision-date
- exclude-search:
exclude:
- _private/*.md
- _snippets/*.*
- extra_css/*.*
#- section-index
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/block-core/documentation
- icon: fontawesome/brands/twitter
link: https://twitter.com/blockcoredev
generator: false
# version:
# provider: mike
nav:
- index.md
- introduction.md
- Platform:
- overview.md
- usecases.md
- referencenodes.md
- walkthrough.md
- Architecture:
- architecture.md
- release-process.md
- Node:
- Features:
- node/features/index.md
- node/features/airdrop.md
- node/features/blockstore.md
- node/features/blockexplorer.md
- node/features/coldstaking.md
- node/features/consensus.md
- node/features/diagnostics.md
- node/features/dns.md
- node/features/memorypool.md
- node/features/miner.md
- node/features/nodehost.md
- node/features/notifications.md
- node/features/poa.md
- node/features/rpc.md
- node/features/storage.md
- node/features/wallet.md
- node/features/walletwatchonly.md
- node/features/walletnotify.md
- API:
- node/api/index.md
- node/api/apiauthentication.md
- node/api/apiauthorization.md
- P2P:
- node/p2p/index.md
- node/p2p/payloads.md
- Community and Support:
- FAQ:
- faq/index.md
- faq/faq-general.md
- faq/faq-deployment.md
- faq/faq-synchronization.md
- faq/faq-integrations.md
- faq/faq-wallet.md
- support.md
- contribute.md
- signingcommits.md
- securityissues.md
- development.md
- community.md
# - Example Projects:
# - example-projects/index.md
# - example-projects/mithril-shards-example.md
# - example-projects/mithril-shards-example-network-bedrock.md
# - example-projects/mithril-shards-example-dev.md
# - example-projects/mithril-shards-example-node.md
# - example-projects/running-example.md
- Links:
- links.md