-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
93 lines (90 loc) · 4.32 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
# Project information
site_name: Substrate Doc Sandbox
#repo_url: https://github.com/example/repository/
#docs_dir: 'docs-sandbox'
# Copyright
copyright: 'Copyright © 2021. All rights reserved.'
# Configuration
theme:
name: material
custom_dir: my-overrides
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.indexes
- navigation.tracking
- navigation.sections
#- toc.integrate
language: 'en'
# Navigation
nav:
- 'index.md'
- 'Quick start': 'quickstart.md'
- 'Docs':
- main-docs/index.md
- 'Why Substrate?': 'main-docs/01-why-substrate/index.md'
- 'Fundamentals':
- 'main-docs/02-fundamentals/index.md'
- 'Blockchain basics': 'main-docs/02-fundamentals/blockchain-basics.md'
- 'Substrate node architecture': 'main-docs/02-fundamentals/architecture.md'
- 'Consensus': 'main-docs/02-fundamentals/consensus.md'
- 'Rust': 'main-docs/02-fundamentals/rust-basics.md'
- 'Install':
- 'main-docs/03-install/index.md'
- 'Rust compiler and toolchain': 'main-docs/03-install/rust-builds.md'
- 'Linux': 'main-docs/03-install/linux.md'
- 'macOS': 'main-docs/03-install/macos.md'
- 'Windows': 'main-docs/03-install/windows.md'
- 'Substrate and runtime tools': 'main-docs/03-install/other-tools.md'
- 'Explore': 'main-docs/04-explore/explore.md'
- 'Design':
- 'main-docs/05-design/index.md'
- 'Smart contract or runtime development': 'main-docs/05-design/runtime-or-smart-contracts/index.md'
- 'Build':
- 'main-docs/06-build/libraries.md'
- 'main-docs/06-build/tools.md'
- 'main-docs/06-build/build-process.md'
- 'main-docs/06-build/custom-pallets.md'
- 'main-docs/06-build/frontend.md'
- 'Test': 'main-docs/07-test/test.md'
- 'Deploy': 'main-docs/08-deploy/deploy.md'
#- 'Migrate': 'main-docs/08-deploy/migrate.md'
#- 'Monitor': 'main-docs/08-deploy/monitor.md'
#- 'Operate': 'main-docs/08-deploy/operate.md'
- 'Maintain':
- 'main-docs/09-maintain/index.md'
- 'Upgrade': 'main-docs/09-maintain/upgrade.md'
#- 'Retire': 'main-docs/retire.md'
- 'Tutorials':
- tutorials/index.md
- 'Build a local blockchain': 'tutorials/01-build-local-blockchain.md'
- 'Simulate a network': 'tutorials/02-simulate-network.md'
- 'Start a trusted validator network': 'tutorials/03-private-network.md'
#- 'Grant permissions to specific nodes in a network': 'tutorials/04-permissions.md
#- 'Monitor a network and view node metrics': 'tutorials/05-monitor.md
- 'Add a simple pallet to the runtime': 'tutorials/07-add-a-pallet.md'
#- 'Configure the contracts pallet': 'tutorials/contracts-pallet.md'
#- 'Write a smart contract with ink!': 'tutorials/ink-contract.md'
- 'Create a custom pallet using macros': 'tutorials/custom-pallet.md'
#- 'Publish a custom pallet': 'tutorials/publish-pallet.md'
#- 'Upgrade the runtime': 'tutorials/forkless-upgrade.md'
#- 'Connect to a local relay chain': 'tutorials/relay-chain.md'
#- 'Connect a parachain to Polkadot': 'tutorials/parachain.md'
#- 'Connect a Substrate blockchain to Ethereum': 'tutorials/connect-to-evm.md'
- 'Reference':
- 'reference/index.md'
- 'FRAME pallets': 'reference/frame-pallets.md'
- 'Rust API': 'https://docs.substrate.io/rustdocs/"target="_blank'
- 'How-to quick reference guides':
- 'reference/how-to-guides/index.md'
- 'Polkadot-JS': 'reference/polkadot-js.md'
- 'Client libraries': 'reference/client-lib.md'
- 'Glossary': 'reference/glossary.md'
- 'Community':
- 'community/index.md'
- 'Writing style guidelines': 'community/style-guide.md'
- 'Site builder guidelines': 'community/site-building.md'
- 'How-to topic template': 'https://github.com/substrate-developer-hub/substrate-docs/blob/main/static/assets/contribute-templates/how-to-template.md/"target="_blank'
- 'Bounties': 'community/bounty.md'
- 'Dropbox': 'faq-dropbox/index.md'
- 'Playground': 'https://docs.substrate.io/playground/"target="_blank'