-
Notifications
You must be signed in to change notification settings - Fork 7
/
mkdocs.yml
175 lines (163 loc) · 6.95 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
site_name: Aleph.im Documentation
theme:
name: material
logo: assets/images/square-logo-color.png
custom_dir: overrides/
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.path
- navigation.tabs
markdown_extensions:
- admonition
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.arithmatex:
generic: true
- pymdownx.tabbed:
alternate_style: true
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra_css:
- assets/stylesheets/aleph-branding.css
repo_url: https://github.com/aleph-im/aleph-docs
edit_uri: edit/main/docs/
nav:
- 'What Is Aleph.im?':
- 'Introduction to aleph.im': index.md
- 'How to use aleph.im': protocol/usage.md
- 'How to stake': tools/aleph-account.md
- 'Links & FAQ': faq.md
- 'Supported chains': protocol/chains.md
- 'Roadmap 2024': protocol/roadmap2024.md
- 'The message protocol': protocol/messages.md
- 'Aleph.im in action':
- 'Blog & Partnerships': community/blog.md
- 'Community projects': community/projects/index.md
- 'Potential use cases': community/use-cases.md
- 'Node Operations':
- 'Core Channel Nodes (CCNs)':
- 'Introduction': nodes/core/index.md
- 'Backups': nodes/core/backups.md
- 'Compute Resource Nodes (CRNs)':
- 'Introduction': nodes/compute/index.md
- 'Installations':
- 'Configure Caddy': nodes/compute/installation/configure-caddy.md
- 'Debian 11': nodes/compute/installation/debian-11.md
- 'Debian 12': nodes/compute/installation/debian-12.md
- 'Ubuntu 20.04': nodes/compute/installation/ubuntu-20.04.md
- 'Ubuntu 22.04': nodes/compute/installation/ubuntu-22.04.md
- 'Troubleshooting': nodes/compute/troubleshooting.md
- 'Releases': nodes/compute/releases.md
- 'Reliability':
- 'Introduction': nodes/reliability/index.md
- 'Monitoring': nodes/reliability/monitoring.md
- 'Metrics': nodes/reliability/metrics.md
- 'Scores': nodes/reliability/scores.md
- 'Rewards': nodes/reliability/rewards.md
- 'Developer Hub':
- 'Tools':
- 'Aleph CLI':
- 'Getting started': tools/aleph-client/index.md
- 'Usage': tools/aleph-client/usage.md
- 'Web Console':
- 'Getting started': tools/webconsole/index.md
- 'Upload': tools/webconsole/upload.md
- 'Write your code': tools/webconsole/write_your_code.md
- 'Languages':
- 'NodeJS': tools/webconsole/languages/nodejs.md
- 'Python': tools/webconsole/languages/python.md
- 'Others': tools/webconsole/languages/other.md
- 'Multichain Indexer':
- 'Introduction': tools/indexer/index.md
- 'Generate Solana indexers from IDL': tools/indexer/indexer-generator.md
- 'The EVM indexer guide': tools/indexer/evm-indexer.md
- 'Verifiable Random Functions': tools/vrf.md
- 'Building dApps':
- 'Using Messages':
- 'Introduction': protocol/messages.md
- 'Aggregates': protocol/object-types/aggregates.md
- 'Posts': protocol/object-types/posts.md
- 'Programs': protocol/object-types/programs.md
- 'Storage': protocol/object-types/storage.md
- 'Permissions': protocol/permissions.md
- 'Deploying VMs':
- 'Introduction': computing/index.md
- 'Runtimes':
- 'What is a runtime?': computing/runtimes/index.md
- 'Custom runtimes': computing/runtimes/custom.md
- 'Volumes':
- 'Immutable': computing/volumes/immutable.md
- 'Persistent': computing/volumes/persistent.md
- 'Tutorials':
- 'Testing microVMs': guides/testing_microvms.md
- 'Update a program': guides/update_a_program.md
- 'Local Testing': nodes/compute/advanced/local-testing.md
- 'Python':
- 'Getting Started': guides/python/getting_started.md
- 'Advanced': guides/python/advanced.md
- 'Dependency volume': guides/python/dependency_volume.md
- 'Rust':
- 'Rust microVMs': guides/rust/rust_microvm.md
- 'IPFS Pinning': tools/ipfs-pinning.md
- 'Add a Custom Domain': computing/custom_domain/setup.md
- 'SDKs and APIs':
- 'Typescript SDK':
- 'Introduction': libraries/typescript-sdk/index.md
- 'Account': libraries/typescript-sdk/accounts.md
- 'Aggregates': libraries/typescript-sdk/aggregates.md
- 'Instances': libraries/typescript-sdk/instances.md
- 'Posts': libraries/typescript-sdk/posts.md
- 'Troubleshooting': libraries/typescript-sdk/troubleshooting.md
- 'Python SDK':
- 'Introduction': libraries/python-sdk/index.md
- 'Account': libraries/python-sdk/accounts.md
- 'Forget': libraries/python-sdk/forget.md
- 'Errors': libraries/python-sdk/error.md
- 'Posts':
- 'Create': libraries/python-sdk/posts/create.md
- 'Query': libraries/python-sdk/posts/query.md
- 'Aggregates':
- 'Create': libraries/python-sdk/aggregates/create.md
- 'Query': libraries/python-sdk/aggregates/query.md
- 'Delegate': libraries/python-sdk/aggregates/delegate.md
hooks:
- version_hook.py
plugins:
- search
- redirects:
redirect_maps:
'protocol/object_types/aggregates.md': 'protocol/object-types/aggregates.md'
'protocol/object_types/posts.md': 'protocol/object-types/posts.md'
'protocol/object_types/programs.md': 'protocol/object-types/programs.md'
'protocol/object_types/storage.md': 'protocol/object-types/storage.md'
'libraries/Aleph.im-TypeScript-SDK/index.md': 'libraries/typescript-sdk/index.md'
'libraries/Aleph.im-TypeScript-SDK/accounts.md': 'libraries/typescript-sdk/accounts.md'
'libraries/Aleph.im-TypeScript-SDK/aggregates.md': 'libraries/typescript-sdk/aggregates.md'
'libraries/Aleph.im-TypeScript-SDK/instances.md': 'libraries/typescript-sdk/instances.md'
'libraries/Aleph.im-TypeScript-SDK/posts.md': 'libraries/typescript-sdk/posts.md'
'libraries/Aleph.im-Python-SDK/index.md': 'libraries/python-sdk/index.md'
'nodes/compute/installation/configure_caddy.md': 'nodes/compute/installation/configure-caddy.md'
'computing/runtimes/existing.md': 'computing/runtimes/index.md#existing-runtimes'
'tools/aleph-tooling.md': 'protocol/usage.md'