-
Notifications
You must be signed in to change notification settings - Fork 91
Expand file tree
/
Copy pathmkdocs.yml
More file actions
252 lines (240 loc) · 10.5 KB
/
mkdocs.yml
File metadata and controls
252 lines (240 loc) · 10.5 KB
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
site_name: 'HyperBEAM - Documentation'
repo_url: https://github.com/permaweb/HyperBEAM
repo_name: 'permaweb/HyperBEAM'
site_url: http://[::]:8000/
docs_dir: docs
site_dir: mkdocs-site
use_directory_urls: false
nav:
- Introduction:
- What is AO-Core?: 'introduction/what-is-ao-core.md'
- What is HyperBEAM?: 'introduction/what-is-hyperbeam.md'
- AO Devices: 'introduction/ao-devices.md'
- Pathing in AO-Core: 'introduction/pathing-in-ao-core.md'
- Run a Node:
- Running a HyperBEAM node: 'run/running-a-hyperbeam-node.md'
- Configuring your machine: 'run/configuring-your-machine.md'
- TEE nodes: 'run/tee-nodes.md'
- Joining/running a router: 'run/joining-running-a-router.md'
- Build on HyperBEAM:
- Get started building on AO-Core: 'build/get-started-building-on-ao-core.md'
- Exposing process state: 'build/exposing-process-state.md'
- Serverless decentralized compute: 'build/serverless-decentralized-compute.md'
- Extending HyperBEAM: 'build/extending-hyperbeam.md'
- Devices:
- Overview: 'devices/overview.md'
- '~meta@1.0': 'devices/meta-at-1-0.md'
- '~process@1.0': 'devices/process-at-1-0.md'
- '~message@1.0': 'devices/message-at-1-0.md'
- '~wasm64@1.0': 'devices/wasm64-at-1-0.md'
- '~lua@5.3a': 'devices/lua-at-5-3a.md'
- '~json@1.0': 'devices/json-at-1-0.md'
- '~scheduler@1.0': 'devices/scheduler-at-1-0.md'
- '~relay@1.0': 'devices/relay-at-1-0.md'
- Resources:
# - Overview: 'resources/source-code/index.md'
- FAQ: 'resources/reference/faq.md'
- LLMs.txt: 'resources/llms.md'
- Glossary: 'resources/reference/glossary.md'
- Source Code Modules:
- Modules:
- ar_bundles: 'resources/source-code/ar_bundles.md'
- ar_deep_hash: 'resources/source-code/ar_deep_hash.md'
- ar_rate_limiter: 'resources/source-code/ar_rate_limiter.md'
- ar_timestamp: 'resources/source-code/ar_timestamp.md'
- ar_tx: 'resources/source-code/ar_tx.md'
- ar_wallet: 'resources/source-code/ar_wallet.md'
- dev_cache: 'resources/source-code/dev_cache.md'
- dev_cacheviz: 'resources/source-code/dev_cacheviz.md'
- dev_codec_ans104: 'resources/source-code/dev_codec_ans104.md'
- dev_codec_flat: 'resources/source-code/dev_codec_flat.md'
- dev_codec_httpsig_conv: 'resources/source-code/dev_codec_httpsig_conv.md'
- dev_codec_httpsig: 'resources/source-code/dev_codec_httpsig.md'
- dev_codec_json: 'resources/source-code/dev_codec_json.md'
- dev_codec_structured: 'resources/source-code/dev_codec_structured.md'
- dev_cron: 'resources/source-code/dev_cron.md'
- dev_cu: 'resources/source-code/dev_cu.md'
- dev_dedup: 'resources/source-code/dev_dedup.md'
- dev_delegated_compute: 'resources/source-code/dev_delegated_compute.md'
- dev_faff: 'resources/source-code/dev_faff.md'
- dev_genesis_wasm: 'resources/source-code/dev_genesis_wasm.md'
- dev_green_zone: 'resources/source-code/dev_green_zone.md'
- dev_hyperbuddy: 'resources/source-code/dev_hyperbuddy.md'
- dev_json_iface: 'resources/source-code/dev_json_iface.md'
- dev_local_name: 'resources/source-code/dev_local_name.md'
- dev_lookup: 'resources/source-code/dev_lookup.md'
- dev_lua_lib: 'resources/source-code/dev_lua_lib.md'
- dev_lua_test: 'resources/source-code/dev_lua_test.md'
- dev_lua: 'resources/source-code/dev_lua.md'
- dev_manifest: 'resources/source-code/dev_manifest.md'
- dev_message: 'resources/source-code/dev_message.md'
- dev_meta: 'resources/source-code/dev_meta.md'
- dev_monitor: 'resources/source-code/dev_monitor.md'
- dev_multipass: 'resources/source-code/dev_multipass.md'
- dev_name: 'resources/source-code/dev_name.md'
- dev_node_process: 'resources/source-code/dev_node_process.md'
- dev_p4: 'resources/source-code/dev_p4.md'
- dev_patch: 'resources/source-code/dev_patch.md'
- dev_poda: 'resources/source-code/dev_poda.md'
- dev_process_cache: 'resources/source-code/dev_process_cache.md'
- dev_process_worker: 'resources/source-code/dev_process_worker.md'
- dev_process: 'resources/source-code/dev_process.md'
- dev_push: 'resources/source-code/dev_push.md'
- dev_relay: 'resources/source-code/dev_relay.md'
- dev_router: 'resources/source-code/dev_router.md'
- dev_scheduler_cache: 'resources/source-code/dev_scheduler_cache.md'
- dev_scheduler_formats: 'resources/source-code/dev_scheduler_formats.md'
- dev_scheduler_registry: 'resources/source-code/dev_scheduler_registry.md'
- dev_scheduler_server: 'resources/source-code/dev_scheduler_server.md'
- dev_scheduler: 'resources/source-code/dev_scheduler.md'
- dev_simple_pay: 'resources/source-code/dev_simple_pay.md'
- dev_snp_nif: 'resources/source-code/dev_snp_nif.md'
- dev_snp: 'resources/source-code/dev_snp.md'
- dev_stack: 'resources/source-code/dev_stack.md'
- dev_test: 'resources/source-code/dev_test.md'
- dev_wasi: 'resources/source-code/dev_wasi.md'
- dev_wasm: 'resources/source-code/dev_wasm.md'
- hb_ao_test_vectors: 'resources/source-code/hb_ao_test_vectors.md'
- hb_ao: 'resources/source-code/hb_ao.md'
- hb_app: 'resources/source-code/hb_app.md'
- hb_beamr_io: 'resources/source-code/hb_beamr_io.md'
- hb_beamr: 'resources/source-code/hb_beamr.md'
- hb_cache_control: 'resources/source-code/hb_cache_control.md'
- hb_cache_render: 'resources/source-code/hb_cache_render.md'
- hb_cache: 'resources/source-code/hb_cache.md'
- hb_client: 'resources/source-code/hb_client.md'
- hb_crypto: 'resources/source-code/hb_crypto.md'
- hb_debugger: 'resources/source-code/hb_debugger.md'
- hb_escape: 'resources/source-code/hb_escape.md'
- hb_event: 'resources/source-code/hb_event.md'
- hb_examples: 'resources/source-code/hb_examples.md'
- hb_features: 'resources/source-code/hb_features.md'
- hb_gateway_client: 'resources/source-code/hb_gateway_client.md'
- hb_http_benchmark_tests: 'resources/source-code/hb_http_benchmark_tests.md'
- hb_http_client_sup: 'resources/source-code/hb_http_client_sup.md'
- hb_http_client: 'resources/source-code/hb_http_client.md'
- hb_http_server: 'resources/source-code/hb_http_server.md'
- hb_http: 'resources/source-code/hb_http.md'
- hb_json: 'resources/source-code/hb_json.md'
- hb_logger: 'resources/source-code/hb_logger.md'
- hb_message: 'resources/source-code/hb_message.md'
- hb_metrics_collector: 'resources/source-code/hb_metrics_collector.md'
- hb_name: 'resources/source-code/hb_name.md'
- hb_opts: 'resources/source-code/hb_opts.md'
- hb_path: 'resources/source-code/hb_path.md'
- hb_persistent: 'resources/source-code/hb_persistent.md'
- hb_private: 'resources/source-code/hb_private.md'
- hb_process_monitor: 'resources/source-code/hb_process_monitor.md'
- hb_router: 'resources/source-code/hb_router.md'
- hb_singleton: 'resources/source-code/hb_singleton.md'
- hb_store_fs: 'resources/source-code/hb_store_fs.md'
- hb_store_gateway: 'resources/source-code/hb_store_gateway.md'
- hb_store_remote_node: 'resources/source-code/hb_store_remote_node.md'
- hb_store_rocksdb: 'resources/source-code/hb_store_rocksdb.md'
- hb_store: 'resources/source-code/hb_store.md'
- hb_structured_fields: 'resources/source-code/hb_structured_fields.md'
- hb_sup: 'resources/source-code/hb_sup.md'
- hb_test_utils: 'resources/source-code/hb_test_utils.md'
- hb_tracer: 'resources/source-code/hb_tracer.md'
- hb_util: 'resources/source-code/hb_util.md'
- hb_volume: 'resources/source-code/hb_volume.md'
- hb: 'resources/source-code/hb.md'
- rsa_pss: 'resources/source-code/rsa_pss.md'
# - Troubleshooting: 'resources/reference/troubleshooting.md'
# - Community:
# - Contribute Overview: 'community/guidelines.md'
# - Development Setup: 'community/setup.md'
# - Contributing Documentation: 'community/contributing-docs.md'
markdown_extensions:
- attr_list
- md_in_html
- admonition
- pymdownx.superfences
- pymdownx.betterem
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.critic
- pymdownx.keys
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- toc:
toc_depth: 2
permalink: true
theme:
name: material
custom_dir: docs/theme/templates
language: en
logo: https://arweave.net/e8SdCkAlqpMqvBSUuHu7sYpfZWoJsRKG7XuK0EXon_0
favicon: https://arweave.net/zMT0qotUQUmPUYhGcgLr80XhG7GRmYXeLWWGitok6Ao
icon:
repo: fontawesome/brands/github
features:
# - navigation.instant
- navigation.instant.progress
- navigation.instant.prefetch
- navigation.tracking
- navigation.sections
- navigation.path
- navigation.expand
- navigation.tabs
- navigation.tabs.sticky
- navigation.indexes
- navigation.prune
- toc.integrate
- content.tooltips
- content.code.copy
- content.code.select
- content.code.annotate
- navigation.footer
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: default
primary: white
accent: blue
toggle:
icon: material/brightness-7
name: Switch to light mode
font:
text: DM Sans
nav_style: default
highlightjs: true
plugins:
- search
- git-revision-date-localized
extra_css:
- assets/style.css
extra_javascript:
- js/utc-time.js
- js/custom-header.js
- js/parallax.js
- js/navigation.js
- js/toc-highlight.js
- js/disable-preload-transition.js
- js/header-scroll.js
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/permaweb/hyperBEAM
name: GitHub
generator: false