forked from decred/dcrdevdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
135 lines (134 loc) · 5.05 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
site_name: Decred Developer Documentation
site_url: https://devdocs.decred.org
use_directory_urls: true
validation:
# Increase severity of validation rules to trigger build failures on common mistakes.
absolute_links: warn
unrecognized_links: warn
nav:
omitted_files: warn
absolute_links: warn
watch:
- "docs"
theme:
name: material
favicon: 'img/favicon.ico?v=s3ss'
logo: 'img/decred_logo_symbol_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:
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/dcrdevdocs
repo_name: decred/dcrdevdocs
markdown_extensions:
- footnotes
- smarty
- admonition
- toc
- tables
- attr_list
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra_css:
- css/fonts.css
- css/style.css
plugins:
- markdownextradata
- search
- social:
enabled: !ENV [DCRDEVDOCS_CARDS, false]
cards_layout_options:
font_family: 'Source Sans 3'
background_color: '#091440'
color: '#FFFFFF'
nav:
- 'Home': 'index.md'
- 'Projects': 'projects.md'
- Core Blockchain Concepts:
- 'Blockchain': 'core-blockchain-concepts/blockchain.md'
- Proof-of-Stake (PoS):
- 'Stake Enabled Height (SEH)': 'core-blockchain-concepts/proof-of-stake/stake-enabled-height.md'
- 'Stake Validation Height (SVH)': 'core-blockchain-concepts/proof-of-stake/stake-validation-height.md'
- Developer Guides:
- Transactions:
- 'Transactions': 'developer-guides/transactions/transactions.md'
- 'Transaction Format': 'developer-guides/transactions/transaction-format.md'
- 'Transaction Extensions': 'developer-guides/transactions/transaction-extensions.md'
- txscript:
- "Overview": 'developer-guides/transactions/txscript/overview.md'
- "Opcodes": 'developer-guides/transactions/txscript/opcodes.md'
- Wallets:
- 'Overview': 'developer-guides/wallets/overview.md'
- 'Seed Generation Process': 'developer-guides/wallets/mnemonic-seed.md'
- 'Deterministic Wallet Formats': 'developer-guides/wallets/deterministic-wallet-formats.md'
- 'Addresses': 'developer-guides/addresses.md'
- 'Blockchain Parameters': 'developer-guides/blockchain-parameters.md'
- 'Block Header Specifications': 'developer-guides/block-header-specifications.md'
- 'Script Extensions': 'developer-guides/script-extensions.md'
- 'Merkle Root Construction': 'developer-guides/merkle-root-construction.md'
- 'Ticket Selection': 'developer-guides/ticket-selection.md'
- 'Reproducible Builds': 'developer-guides/reproducible-builds.md'
- Protocol / Peer-to-Peer (P2P) Network:
- 'Peer Discovery': 'protocol-p2p-network/peer-discovery.md'
- 'Initial Block Download': 'protocol-p2p-network/initial-block-download.md'
- 'Orphan Blocks': 'protocol-p2p-network/orphan-blocks.md'
- 'Transaction Broadcasting': 'protocol-p2p-network/transaction-broadcasting.md'
- 'Memory Pool': 'protocol-p2p-network/memory-pool.md'
- Environments:
- 'Mainnet': 'environments/mainnet.md'
- 'Testnet': 'environments/testnet.md'
- 'Simnet': 'environments/simnet.md'
- 'Regnet': 'environments/regnet.md'
- Contributing:
- 'Contributor Guidelines': 'contributing/contributor-guidelines.md'
copyright: If you wish to improve this site, please <a href="https://github.com/decred/dcrdevdocs/issues/new">open an issue</a> or <a href="https://github.com/decred/dcrdevdocs/compare">send a pull request</a>.<br />dcrdevdocs v0.0.1. Decred Project 2020-2024.