-
Notifications
You must be signed in to change notification settings - Fork 120
/
mkdocs.yml
212 lines (212 loc) · 8.06 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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
site_name: Nano Documentation
site_url: https://docs.nano.org/
theme:
name: 'material'
palette:
- scheme: nano
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
font:
text: 'Noto Sans'
code: 'Roboto Mono'
icon:
repo: 'fontawesome/brands/github'
logo: 'images/nano-logo.svg'
favicon: 'images/favicon.png'
custom_dir: 'theme-overrides'
features:
- content.tabs.link
- navigation.indexes
- navigation.expand
- navigation.tabs
- navigation.top
- search.share
- search.suggest
- content.tabs.link
- navigation.indexes
- navigation.expand
nav:
- Home: index.md
- What is Nano?: what-is-nano/overview.md
- Running a Node:
- Overview: running-a-node/overview.md
- Security: running-a-node/security.md
- Node Setup: running-a-node/node-setup.md
- Wallet Setup: running-a-node/wallet-setup.md
- Docker Management: running-a-node/docker-management.md
- Configuration: running-a-node/configuration.md
- Logging & Tracing: running-a-node/logging-tracing.md
- Ledger Management: running-a-node/ledger-management.md
- Voting as a Representative: running-a-node/voting-as-a-representative.md
- Advanced Monitoring: running-a-node/advanced-monitoring.md
- Beta Network: running-a-node/beta-network.md
- Test Network: running-a-node/test-network.md
- Troubleshooting: running-a-node/troubleshooting.md
- Beyond the Node: running-a-node/beyond-the-node.md
- Integration Guides:
- integration-guides/index.md
- The Basics: integration-guides/the-basics.md
- Key Management: integration-guides/key-management.md
- Block Confirmation Tracking: integration-guides/block-confirmation-tracking.md
- Work Generation: integration-guides/work-generation.md
- Build Options: integration-guides/build-options.md
- WebSockets: integration-guides/websockets.md
- IPC Integration: integration-guides/ipc-integration.md
- Advanced: integration-guides/advanced.md
- Living Whitepaper:
- living-whitepaper/index.md
- Protocol Design:
- Introduction: protocol-design/introduction.md
- Ledger: protocol-design/ledger.md
- Blocks: protocol-design/blocks.md
- Spam, Work, & Prioritization: protocol-design/spam-work-and-prioritization.md
- Networking: protocol-design/networking.md
- ORV Consensus: protocol-design/orv-consensus.md
- Attack Vectors: protocol-design/attack-vectors.md
- Resource Usage: protocol-design/resource-usage.md
- Distribution and Units: protocol-design/distribution-and-units.md
- Signing, Hashing and Key Derivation: protocol-design/signing-hashing-and-key-derivation.md
- Original whitepaper: whitepaper/english.md
- Node Implementation:
- Introduction: node-implementation/introduction.md
- Components: node-implementation/components.md
- Database: node-implementation/database.md
- Blocks: node-implementation/blocks.md
- Networking: node-implementation/networking.md
- Voting: node-implementation/voting.md
- Work: node-implementation/work.md
- Core Development:
- Overview: core-development/overview.md
- Collaboration Process: core-development/collaboration-process.md
- Code Standards: core-development/code-standards.md
- Understanding the Code: core-development/understanding-the-code.md
- Developer Discussions: core-development/developer-discussions.md
- Commands:
- RPC Protocol: commands/rpc-protocol.md
- Command Line Interface: commands/command-line-interface.md
- Releases:
- Node Releases: releases/node-releases.md
- Release Notes:
- V27.1 (Latest): releases/release-v27-1.md
- V27.0: releases/release-v27-0.md
- V26.1: releases/release-v26-1.md
- V26.0: releases/release-v26-0.md
- V25.1: releases/release-v25-1.md
- V25.0: releases/release-v25-0.md
- V24.0: releases/release-v24-0.md
- V23.3: releases/release-v23-3.md
- V23.1: releases/release-v23-1.md
- V23.0: releases/release-v23-0.md
- V22.1: releases/release-v22-1.md
- V22.0: releases/release-v22-0.md
- V21.3: releases/release-v21-3.md
- V21.2: releases/release-v21-2.md
- V21.1: releases/release-v21-1.md
- V21.0: releases/release-v21-0.md
- V20.0: releases/release-v20-0.md
- V19.0: releases/release-v19-0.md
- Network Upgrades: releases/network-upgrades.md
- Roadmap: releases/roadmap.md
- Glossary: glossary.md
markdown_extensions:
- admonition
- attr_list
- codehilite:
guess_lang: false
- footnotes
- meta
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
base_path: 'docs/snippets'
- pymdownx.striphtml:
strip_comments: true
strip_attributes: ''
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- toc:
permalink: true
toc_depth: 4
extra_javascript:
- 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
- 'https://unpkg.com/mermaid@8.13.3/dist/mermaid.min.js'
- 'javascript/mermaid-loose-security.js'
extra_css:
- 'stylesheets/extras.css'
extra:
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/nanocurrency'
- icon: 'fontawesome/brands/twitter'
link: 'https://twitter.com/nano'
- icon: 'material/comment-multiple'
link: 'https://chat.nano.org'
- icon: 'fontawesome/brands/reddit'
link: 'https://reddit.com/r/nanocurrency'
- icon: 'fontawesome/brands/medium'
link: 'https://medium.com/nanocurrency'
- icon: 'fontawesome/brands/facebook'
link: 'https://facebook.com/nanofoundation'
- icon: 'fontawesome/brands/linkedin'
link: 'https://linkedin.com/company/nano-foundation'
- icon: 'fontawesome/brands/youtube'
link: 'https://www.youtube.com/nanocurrency/'
- icon: 'fontawesome/brands/instagram'
link: 'https://www.instagram.com/nanocurrency/'
consent:
title: Cookie consent
description: >-
We use necessary cookies to make our site work. By using this and related Nano.org sites,
you are accepting these cookies. For more detailed information, see the Cookies section
in our <a href="https://nano.org/privacy" target="_blank" rel="noopener">Privacy Policy</a>.
analytics:
provider: google
property: G-RGP8S06PYJ
repo_name: 'nanocurrency/nano-docs'
repo_url: 'https://github.com/nanocurrency/nano-docs'
edit_uri: 'edit/main/docs/'
plugins:
- search:
separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
- social:
cards: !ENV [ PRODUCTION, FALSE ]
cards_layout_options:
background_color: "#20204c"
color: "#FFFFFF"
- redirects:
redirect_maps:
'running-a-node/rocksdb-ledger-backend.md': 'running-a-node/ledger-management.md'
'protocol-design/network-attacks.md': 'protocol-design/attack-vectors.md'
'what-is-nano/contributing.md': 'core-development/overview.md'
'what-is-nano/exploring-more.md': 'what-is-nano/overview.md'
'releases/roadmap.md': 'https://github.com/orgs/nanocurrency/projects/27'
'releases/upcoming-features.md': 'https://github.com/orgs/nanocurrency/projects/27'
'releases/current-release-notes.md': 'releases/release-v27-1.md'
'node-implementation/contributing.md': 'core-development/overview.md'