forked from decred/dcrdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
274 lines (273 loc) · 12.5 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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
site_name: Decred Documentation
site_url: https://docs.decred.org
use_directory_urls: true
watch:
- "docs"
- "snippets"
theme:
name: material
favicon: 'img/favicon.ico?v=s3ss'
logo: 'img/decred_logo_symbol_color_gradient_128.svg'
font: false
features:
- navigation.instant
icon:
repo: octicons/mark-github-16
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: dcrdocs-light
# Primary and accent colours should be fully overridden by dcrdocs-light theme.
# If any green shows up in the site, thats a bug.
primary: green
accent: green
toggle:
icon: material/weather-night
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: dcrdocs-dark
# Primary and accent colours should be fully overridden by dcrdocs-dark theme.
# If any green shows up in the site, thats a bug.
primary: green
accent: green
toggle:
icon: material/weather-sunny
name: Switch to light mode
extra:
decreditonversion: 1.6.3
cliversion: 1.7.2
lndversion: 0.3.0
social:
- icon: octicons/mark-github-16
link: https://github.com/decred
name: GitHub
- icon: fontawesome/brands/twitter
link: https://twitter.com/decredproject
name: Twitter
- icon: fontawesome/brands/medium
link: https://medium.com/decred
name: Medium
- icon: fontawesome/brands/reddit
link: https://www.reddit.com/r/decred/
name: Reddit
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/decredchannel
name: YouTube
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/decredproject/
name: LinkedIn
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/decredproject/
name: Facebook
- icon: fontawesome/brands/weibo
link: https://weibo.com/DecredProject
name: Weibo
repo_url: https://github.com/decred/dcrdocs
repo_name: decred/dcrdocs
markdown_extensions:
- footnotes
- smarty
- admonition
- toc
- tables
- attr_list
- pymdownx.snippets:
check_paths: true
base_path: 'snippets'
- pymdownx.details
- pymdownx.tilde
- pymdownx.caret
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences
extra_css:
- css/fonts.css
- css/style.css
plugins:
- markdownextradata
- search
- social:
cards: !ENV [DCRDOCS_CARDS, false]
cards_font: 'Source Sans Pro'
cards_color:
fill: '#091440'
text: '#FFFFFF'
nav:
- 'Introduction to Decred': 'index.md'
- Getting Started:
- "Beginner's Guide": 'getting-started/beginner-guide.md'
- "Project History": 'getting-started/project-history.md'
- 'Obtaining DCR': 'getting-started/obtaining-dcr.md'
- 'Using the Block Explorer': 'getting-started/using-the-block-explorer.md'
- 'Joining Matrix': 'getting-started/joining-matrix-channels.md'
- 'Articles & Media': 'getting-started/articles-and-media.md'
- 'Business Brief': 'getting-started/business-brief.md'
- Governance:
- 'Governance Overview': 'governance/overview.md'
- Politeia:
- 'Politeia Overview': 'governance/politeia/overview.md'
- 'Proposal Guidelines': 'governance/politeia/proposal-guidelines.md'
- 'Example Proposals': 'governance/politeia/example-proposals.md'
- 'Censorship': 'governance/politeia/politeia-censorship.md'
- Consensus Rule Voting:
- 'Consensus Rule Voting Overview': 'governance/consensus-rule-voting/overview.md'
- 'How to Vote': 'governance/consensus-rule-voting/how-to-vote.md'
- 'Verifying Votes': 'governance/consensus-rule-voting/verifying-votes.md'
- 'Consensus Vote Archive': 'governance/consensus-rule-voting/consensus-vote-archive.md'
- 'Decred Constitution': 'governance/decred-constitution.md'
- Wallets:
- Decrediton (GUI):
- 'Decrediton Setup': 'wallets/decrediton/decrediton-setup.md'
- 'Using Decrediton': 'wallets/decrediton/using-decrediton.md'
- 'Upgrading Decrediton': 'wallets/decrediton/upgrading-decrediton.md'
- 'Migrations': 'wallets/decrediton/migrations.md'
- 'Trezor Wallets': 'wallets/decrediton/trezor.md'
- 'Troubleshooting Problems': 'wallets/decrediton/decrediton-troubleshooting.md'
- CLI Wallet:
- 'CLI Installation': 'wallets/cli/cli-installation.md'
- 'OS Differences': 'wallets/cli/os-differences.md'
- 'Startup Basics': 'wallets/cli/startup-basics.md'
- 'dcrd Setup': 'wallets/cli/dcrd-setup.md'
- 'dcrwallet Setup': 'wallets/cli/dcrwallet-setup.md'
- 'dcrctl Basics': 'wallets/cli/dcrctl-basics.md'
- 'Buying Tickets': 'wallets/cli/dcrwallet-tickets.md'
- 'dcrd and dcrwallet CLI Arguments': 'wallets/cli/dcrd-and-dcrwallet-cli-arguments.md'
- 'dcrctl RPC Commands': 'wallets/cli/dcrctl-rpc-commands.md'
- 'SPV': 'wallets/spv.md'
- 'Hardware Wallets': 'wallets/hardware-wallets.md'
- 'Mobile Wallets': 'wallets/mobile-wallets.md'
- Proof-of-Stake Voting:
- "PoS Voting Overview": 'proof-of-stake/overview.md'
- "How to Stake": 'proof-of-stake/how-to-stake.md'
- "Redeem Script": 'proof-of-stake/redeem-script.md'
- 'Proof-of-Work Mining': 'mining/overview.md'
- Privacy:
- 'General Privacy': 'privacy/general-privacy.md'
- CoinShuffle++:
- 'CoinShuffle++ Overview': 'privacy/cspp/overview.md'
- 'How to use CSPP': 'privacy/cspp/how-to-cspp.md'
- Lightning Network:
- 'Lightning Network Overview': 'lightning-network/overview.md'
- 'Backups': 'lightning-network/backups.md'
- 'Watchtowers': 'lightning-network/watchtowers.md'
- dcrlncli:
- 'Options and Commands': 'lightning-network/dcrlncli/options-and-commands.md'
- Autopilot Commands:
- 'autopilot': 'lightning-network/dcrlncli/autopilot.md'
- Channel Commands:
- 'openchannel': 'lightning-network/dcrlncli/openchannel.md'
- 'closechannel': 'lightning-network/dcrlncli/closechannel.md'
- 'closeallchannels': 'lightning-network/dcrlncli/closeallchannels.md'
- 'abandonchannel': 'lightning-network/dcrlncli/abandonchannel.md'
- 'channelbalance': 'lightning-network/dcrlncli/channelbalance.md'
- 'pendingchannels': 'lightning-network/dcrlncli/pendingchannels.md'
- 'listchannels': 'lightning-network/dcrlncli/listchannels.md'
- 'closedchannels': 'lightning-network/dcrlncli/closedchannels.md'
- 'getnetworkinfo': 'lightning-network/dcrlncli/getnetworkinfo.md'
- 'feereport': 'lightning-network/dcrlncli/feereport.md'
- 'updatechanpolicy': 'lightning-network/dcrlncli/updatechanpolicy.md'
- 'exportchanbackup': 'lightning-network/dcrlncli/exportchanbackup.md'
- 'verifychanbackup': 'lightning-network/dcrlncli/verifychanbackup.md'
- 'restorechanbackup': 'lightning-network/dcrlncli/restorechanbackup.md'
- Graph Commands:
- 'describegraph': 'lightning-network/dcrlncli/describegraph.md'
- 'getnodemetrics': 'lightning-network/dcrlncli/getnodemetrics.md'
- 'getchaninfo': 'lightning-network/dcrlncli/getchaninfo.md'
- 'getnodeinfo': 'lightning-network/dcrlncli/getnodeinfo.md'
- Invoice Commands:
- 'addinvoice': 'lightning-network/dcrlncli/addinvoice.md'
- 'lookupinvoice': 'lightning-network/dcrlncli/lookupinvoice.md'
- 'listinvoices': 'lightning-network/dcrlncli/listinvoices.md'
- 'decodepayreq': 'lightning-network/dcrlncli/decodepayreq.md'
- 'cancelinvoice': 'lightning-network/dcrlncli/cancelinvoice.md'
- 'addholdinvoice': 'lightning-network/dcrlncli/addholdinvoice.md'
- 'settleinvoice': 'lightning-network/dcrlncli/settleinvoice.md'
- Macaroon Commands:
- 'bakemacaroon': 'lightning-network/dcrlncli/bakemacaroon.md'
- 'listmacaroonids': 'lightning-network/dcrlncli/listmacaroonids.md'
- 'deletemacaroonid': 'lightning-network/dcrlncli/deletemacaroonid.md'
- 'listpermissions': 'lightning-network/dcrlncli/listpermissions.md'
- 'printmacaroon': 'lightning-network/dcrlncli/printmacaroon.md'
- On-chain Commands:
- 'estimatefee': 'lightning-network/dcrlncli/estimatefee.md'
- 'sendmany': 'lightning-network/dcrlncli/sendmany.md'
- 'sendcoins': 'lightning-network/dcrlncli/sendcoins.md'
- 'listunspent': 'lightning-network/dcrlncli/listunspent.md'
- 'listchaintxns': 'lightning-network/dcrlncli/listchaintxns.md'
- Payment commands:
- 'sendpayment': 'lightning-network/dcrlncli/sendpayment.md'
- 'payinvoice': 'lightning-network/dcrlncli/payinvoice.md'
- 'sendtoroute': 'lightning-network/dcrlncli/sendtoroute.md'
- 'listpayments': 'lightning-network/dcrlncli/listpayments.md'
- 'queryroutes': 'lightning-network/dcrlncli/queryroutes.md'
- 'fwdinghistory': 'lightning-network/dcrlncli/fwdinghistory.md'
- 'trackpayment': 'lightning-network/dcrlncli/trackpayment.md'
- 'querymc': 'lightning-network/dcrlncli/querymc.md'
- 'queryprob': 'lightning-network/dcrlncli/queryprob.md'
- 'resetmc': 'lightning-network/dcrlncli/resetmc.md'
- 'buildroute': 'lightning-network/dcrlncli/buildroute.md'
- Peer commands:
- 'connect': 'lightning-network/dcrlncli/connect.md'
- 'disconnect': 'lightning-network/dcrlncli/disconnect.md'
- 'listpeers': 'lightning-network/dcrlncli/listpeers.md'
- Startup commands:
- 'create': 'lightning-network/dcrlncli/create.md'
- 'unlock': 'lightning-network/dcrlncli/unlock.md'
- 'changepassword': 'lightning-network/dcrlncli/changepassword.md'
- Wallet commands:
- 'newaddress': 'lightning-network/dcrlncli/newaddress.md'
- 'walletbalance': 'lightning-network/dcrlncli/walletbalance.md'
- 'signmessage': 'lightning-network/dcrlncli/signmessage.md'
- 'verifymessage': 'lightning-network/dcrlncli/verifymessage.md'
- 'wallet': 'lightning-network/dcrlncli/wallet.md'
- Watchtower commands:
- 'tower': 'lightning-network/dcrlncli/tower.md'
- 'wtclient': 'lightning-network/dcrlncli/wtclient.md'
- FAQ:
- 'General FAQs': 'faq/general.md'
- 'Configuration FAQs': 'faq/configuration.md'
- 'Wallets and Seed FAQs': 'faq/wallets-and-seeds.md'
- 'Block FAQs': 'faq/blocks.md'
- 'PoW FAQs': 'faq/proof-of-work-mining.md'
- 'Common Errors and Solutions': 'faq/errors.md'
- PoS:
- 'General PoS FAQs': 'faq/proof-of-stake/general.md'
- 'Solo Voting FAQs': 'faq/proof-of-stake/solo-voting.md'
- 'Buying Tickets and Fee FAQs': 'faq/proof-of-stake/buying-tickets-and-fees.md'
- 'Voting Service Provider FAQs': 'faq/proof-of-stake/voting-service-providers.md'
- Advanced:
- 'Manual CLI Installation': 'advanced/manual-cli-install.md'
- 'dcrtime': 'advanced/dcrtime.md'
- 'Verifying Binaries': 'advanced/verifying-binaries.md'
- 'Premine': 'advanced/premine.md'
- 'Issuance': 'advanced/issuance.md'
- 'Deleting Your Wallet': 'advanced/deleting-your-wallet.md'
- 'Navigating Politeia Data': 'advanced/navigating-politeia-data.md'
- 'Solo Proof-of-Stake (PoS) Voting': 'advanced/solo-proof-of-stake-voting.md'
- 'Operating a VSP': 'advanced/operating-a-vsp.md'
- 'Running a Full Node': 'advanced/full-node.md'
- 'Security': 'advanced/general-security.md'
- 'Atomic Swaps': 'advanced/atomic-swap.md'
- 'Decred Seed and BIP-0039': 'advanced/mnemonic-seed.md'
- 'Secure Cold Wallet Setup': 'advanced/secure-cold-wallet-setup.md'
- Research:
- 'Research Overview': 'research/overview.md'
- 'Hybrid Design': 'research/hybrid-design.md'
- 'Decentralized Stake Pooling': 'research/decentralized-stake-pooling.md'
- 'Elliptic Curve Signature Algorithms': 'research/elliptic-curve-signature-algorithms.md'
- 'BLAKE-256 Hash Function': 'research/blake-256-hash-function.md'
- 'Signature Script Isolation and Fraud Proofs': 'research/signature-script-isolation-and-fraud-proofs.md'
- 'Block Production Times': 'research/block-production-times.md'
- 'Schnorr Signatures': 'research/schnorr-signatures.md'
- 'Miscellaneous Improvements': 'research/miscellaneous-improvements.md'
- Contributing:
- 'Contributing Overview': 'contributing/overview.md'
- 'Contributor Compensation': 'contributing/contributor-compensation.md'
- 'Glossary': 'glossary.md'
- About:
- 'License': 'about/license.md'
copyright: If you wish to improve this site, please <a href="https://github.com/decred/dcrdocs/issues/new">open an issue</a> or <a href="https://github.com/decred/dcrdocs/compare">send a pull request</a>.<br />dcrdocs v0.0.3. Decred Project 2016-2023.