forked from hummingbot/hummingbot-site
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
410 lines (401 loc) · 15.2 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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
# Project info
site_name: Hummingbot
site_description: Hummingbot documentation and website
site_author: Hummingbot Foundation
site_url: https://hummingbot.org
# Repository
repo_name: 'hummingbot/hummingbot'
repo_url: 'https://github.com/hummingbot/hummingbot'
edit_uri: 'https://github.com/hummingbot/hummingbot-site/blob/master/'
# Copyright
copyright: Copyright © 2023 Hummingbot Foundation
# Configuration
theme:
name: material
custom_dir: overrides
logo: assets/brand/logo.svg
favicon: assets/brand/logo-color.png
icon:
repo: fontawesome/brands/github
palette:
# - media: "(prefers-color-scheme: dark)"
- scheme: slate
accent: amber
toggle:
icon: material/brightness-2
name: "Switch to light mode"
# - media: "(prefers-color-scheme: light)"
- scheme: default
accent: deep purple
toggle:
icon: material/brightness-5
name: "Switch to dark mode"
font:
text: Noto Sans
code: Roboto Mono
features:
- navigation.instant
- navigation.instant.prefetch
- navigation.top
- navigation.tracking
- navigation.tabs
- navigation.path
- navigation.indexes
- navigation.prune
- content.code.copy
- toc.follow
- announce.dismiss
# - content.tabs.link
# - content.tooltips
# - search.highlight
plugins:
- search
# - social:
# cards_layout_options:
# background_color: "#151819"
# color: "#5FFFD7"
- blog:
blog_dir: blog
blog_toc: true
post_url_format: "{slug}"
- blog:
blog_dir: academy-content
blog_toc: false
archive_toc: true
categories_toc: true
post_url_format: "{slug}"
- tags:
tags_file: academy/all.md
# - git-revision-date
# - mkdocs-video
extra:
homepage: https://hummingbot.org
generator: true
analytics:
provider: google
property: G-DVHHGW7W9R
feedback:
title: Was this page helpful?
ratings:
- icon: material/thumb-up-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/thumb-down-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by
<a href="https://github.com/hummingbot/hummingbot-site/issues/new?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">filing an issue</a>.
social:
- icon: fontawesome/brands/discord
link: https://discord.gg/hummingbot
- icon: fontawesome/brands/github
link: https://github.com/hummingbot/hummingbot
- icon: fontawesome/brands/youtube
link: https://youtube.com/c/hummingbot
- icon: fontawesome/brands/twitter
link: https://twitter.com/_hummingbot
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/hummingbot-foundation
extra_css:
- assets/css/custom.css
- assets/css/glide.core.css
- assets/css/glide.theme.css
extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- https://cdnjs.cloudflare.com/ajax/libs/Glide.js/3.6.0/glide.min.js
- assets/js/mathjax.js
- assets/js/glide.js
# Extensions
markdown_extensions:
- admonition
- abbr
- attr_list
- md_in_html
- def_list
- footnotes
# - meta
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.keys
# - pymdownx.magiclink:
# user: hummingbot
# repo: hummingbot
# repo_url_shorthand: true
- pymdownx.smartsymbols
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.arithmatex:
generic: true
- toc:
permalink: true
- tables
# Navigation
nav:
- Home: index.md
- Docs:
- Docs: docs/index.md
- Getting Started: getting-started/index.md
- Installation:
- Installation: installation/index.md
- Install via Docker: installation/docker.md
- Install from Source:
- Install from Source: installation/source/index.md
- Linux: installation/linux.md
- MacOS: installation/mac.md
- Windows: installation/windows.md
- Raspberry Pi: installation/raspberry-pi.md
- Post-Installation: installation/post-installation.md
- Using Debugger Tools: installation/debug.md
- Client:
- Client: client/index.md
- User Interface: client/user-interface.md
- Commands and Shortcuts: client/commands-shortcuts.md
- Launch/Exit Hummingbot: client/launch-exit.md
- Create/Delete Password: client/password.md
- Connect Exchange API Keys: client/connect.md
- Config Files: client/config-files.md
- Check Balances: client/balance.md
- Start Strategies and Scripts: client/start-stop.md
- Check Bot/Market Status: client/status.md
- Check Performance: client/history.md
- Find Log Files: client/log-files.md
- Export Trades/Keys: client/export.md
- Advanced Features:
- Adding Commands: developers/commands.md
- Balance Limit: global-configs/balance-limit.md
- Clock Tick Size: global-configs/clock-tick.md
- Command Line Autostart: global-configs/strategy-autostart.md
- Color Settings: global-configs/color-settings.md
- Connect External Database: global-configs/external-db.md
- Debug Console: developers/debug.md
- Kill Switch: global-configs/kill-switch.md
- Market Data Collector: global-configs/data-collector.md
- Override Fees: global-configs/override-fees.md
- Paper Trade: global-configs/paper-trade.md
- Rate Oracle: strategy-configs/rate-oracle.md
- Rate Limits: global-configs/rate-limits-share-pct.md
- Telegram Integration: global-configs/telegram.md
- Gateway:
- Gateway: gateway/index.md
- Installation: gateway/installation.md
- Testing Gateway: gateway/testing.md
- Setting up Gateway: gateway/setup.md
- Working with Tokens: gateway/tokens.md
- Running Strategies and Scripts: gateway/running-dex-bots.md
- Building Gateway Connectors: gateway/adding-dex-connectors.md
- Strategies V2:
- Strategies V2: strategies/index.md
- Architecture: v2-strategies/index.md
- Walkthrough: v2-strategies/walkthrough.md
- Executors:
- Executors: v2-strategies/executors/index.md
- Position Executor: v2-strategies/executors/positionexecutor.md
- DCA Executor: v2-strategies/executors/dcaexecutor.md
- Arbitrage Executor: v2-strategies/executors/arbitrage-executor.md
- TWAP Executor: v2-strategies/executors/twapexecutor.md
- Controllers: v2-strategies/controllers/index.md
- Market Data Provider: v2-strategies/data/index.md
- Candles: v2-strategies/candles/index.md
- Scripts:
- Scripts: scripts/index.md
- Sample Scripts: scripts/examples.md
- Scripts Cheatsheat: scripts/cheatsheet.md
- Strategies V1:
- Strategies V1: v1-strategies/index.md
- Pure Market Making: strategies/pure-market-making.md
- Cross-Exchange Market Making: strategies/cross-exchange-market-making.md
- AMM Arbitrage: strategies/amm-arbitrage.md
- AMM-V3 LP: strategies/amm-v3-lp.md
- Avellaneda Market Making: strategies/avellaneda-market-making.md
- Cross-Exchange Mining: strategies/cross-exchange-mining.md
- Hedge: strategies/hedge.md
- Liquidity Mining: strategies/liquidity-mining.md
- Perpetual Market Making: strategies/perpetual-market-making.md
- Spot Perpetual Arbitrage: strategies/spot-perpetual-arbitrage.md
- TWAP: strategies/twap.md
- PMM Strategy Configs:
- PMM Strategy Configs: strategy-configs/index.md
- Add Transaction Costs: strategy-configs/add-transaction-costs.md
- Order Levels: strategy-configs/order-levels.md
- Filled Order Delay: strategy-configs/filled-order-delay.md
- Hanging Orders: strategy-configs/hanging-orders.md
- Minimum Spread: strategy-configs/minimum-spread.md
- Order Refresh Tolerance: strategy-configs/order-refresh-tolerance.md
- Order Optimization: strategy-configs/order-optimization.md
- Inventory Skew: strategy-configs/inventory-skew.md
- Max Order Age: strategy-configs/max-order-age.md
- Order Override: strategy-configs/order-override.md
- Price Band: strategy-configs/price-band.md
- Price Source: strategy-configs/external-price-source.md
- Ping Pong: strategy-configs/ping-pong.md
- Connectors:
- Connectors: exchanges/index.md
- CEX Connectors:
- CEX Connectors: cex-connectors/index.md
- Binance: exchanges/binance/index.md
- Gate.io: exchanges/gate-io/index.md
- Kucoin: exchanges/kucoin/index.md
- HTX: exchanges/huobi/index.md
- AscendEx : exchanges/ascendex/index.md
- Bit.com: exchanges/bit-com-perpetual.md
- Bitfinex: exchanges/bitfinex.md
- Bitrue: exchanges/bitrue.md
- Bitget: exchanges/bitget-perpetual.md
- BitMart: exchanges/bitmart/index.md
- BTC Markets: exchanges/btc-markets.md
- Bybit: exchanges/bybit.md
- Coinbase: exchanges/coinbase.md
- Foxbit: exchanges/foxbit.md
- HitBTC: exchanges/hitbtc.md
- Kraken: exchanges/kraken/index.md
- MEXC: exchanges/mexc/index.md
- NDAX: exchanges/ndax.md
- OKX: exchanges/okx/okx.md
- Phemex: exchanges/phemex-perpetual.md
- DEX Connectors:
- DEX Connectors: dex-connectors/index.md
- dYdX: exchanges/dydx.md
- Dexalot: exchanges/dexalot.md
- Polkadex: exchanges/polkadex.md
- Injective Helix: exchanges/injective.md
- Mad Meerkat: exchanges/mad-meerkat.md
- Curve: exchanges/curve.md
- Carbon: exchanges/carbon.md
- Hyperliquid: exchanges/hyperliquid.md
- OpenOcean: exchanges/openocean.md
- Osmosis: exchanges/osmosis.md
- Pancakeswap : exchanges/pancakeswap.md
- Pangolin: exchanges/pangolin.md
- Perpetual Protocol: exchanges/perp.md
- Plenty: exchanges/plenty.md
- Quickswap: exchanges/quickswap.md
- Quipuswap: exchanges/quipuswap.md
- Ref: exchanges/ref.md
- Sushiswap: exchanges/sushiswap.md
- Tinyman: exchanges/tinyman.md
- TraderJoe: exchanges/traderjoe.md
- Uniswap : exchanges/uniswap.md
- Vega: exchanges/vega.md
- Vertex: exchanges/vertex.md
- VVS: exchanges/vvs.md
- XRP Ledger: exchanges/xrpl.md
- XSwap: exchanges/xswap.md
- Chain Connectors:
- Chain Connectors: chains/index.md
- Ethereum: chains/ethereum.md
- Avalanche: chains/avalanche.md
- Polygon: chains/polygon.md
- BNB Chain: chains/bnb-chain.md
- Algorand: chains/algorand.md
- Cronos: chains/cronos.md
- Cosmos: chains/cosmos.md
- Harmony: chains/harmony.md
- Injective: chains/injective.md
- Kujira: chains/kujira.md
- NEAR: chains/near.md
- XDC Chain: chains/xdc-chain.md
- Tezos: chains/tezos.md
- XRP Ledger: chains/xrpl.md
- Building Connectors:
- Building Connectors: developers/connectors/index.md
- Exchange API Requirements: developers/connectors/build.md
- Connector Architecture: developers/connectors/architecture/index.md
- Order Lifecycle and Market Events: developers/connectors/architecture/order_lifecycle.md
- Handling Rate Limits with API Throttler: developers/connectors/api_throttler.md
- Spot Connector Developer Checklist: developers/connectors/spot-connector-checklist.md
- Spot Connector QA Checklist: developers/connectors/test.md
- Perp Connector Developer Checklist: developers/connectors/perp-connector-checklist.md
- Perp Connector QA Checklist: developers/connectors/test-perp.md
- Debugging & Testing Connectors: developers/connectors/debug.md
- Other Repos:
- Other Repos: repos/index.md
- Brokers: installation/broker.md
- Dashboard: dashboard/index.md
- Deploy Examples ↗️: https://github.com/hummingbot/deploy-examples
- Glossary: glossary/index.md
- Troubleshooting: troubleshooting.md
- Academy:
- Academy: academy/index.md
- Latest Articles: academy-content/index.md
- All Articles: academy/all.md
- Botcamp ↗️:
- Botcamp: https://www.botcamp.xyz
- Botcamp FAQ: botcamp/faq.md
- Releases:
- Releases: release-notes/index.md
- Release Process: governance/releases.md
- 1.26.0: release-notes/1.26.0.md
- 1.25.0: release-notes/1.25.0.md
- 1.24.0: release-notes/1.24.0.md
- 1.23.0: release-notes/1.23.0.md
- 1.22.0: release-notes/1.22.0.md
- 1.21.0: release-notes/1.21.0.md
- 1.20.0: release-notes/1.20.0.md
- 1.19.0: release-notes/1.19.0.md
- 1.18.0: release-notes/1.18.0.md
- 1.17.0: release-notes/1.17.0.md
- 1.16.0: release-notes/1.16.0.md
- 1.15.0: release-notes/1.15.0.md
- 1.14.0: release-notes/1.14.0.md
- 1.13.0: release-notes/1.13.0.md
- 1.12.0: release-notes/1.12.0.md
- 1.11.0: release-notes/1.11.0.md
- 1.10.0: release-notes/1.10.0.md
- 1.9.0: release-notes/1.9.0.md
- 1.8.0: release-notes/1.8.0.md
- 1.7.0: release-notes/1.7.0.md
- 1.6.0: release-notes/1.6.0.md
- 1.5.0: release-notes/1.5.0.md
- 1.4.0: release-notes/1.4.0.md
- 1.3.0: release-notes/1.3.0.md
- 1.2.0: release-notes/1.2.0.md
- 1.1.1: release-notes/1.1.1.md
- 1.1.0: release-notes/1.1.0.md
- 1.0.1: release-notes/1.0.1.md
- 1.0.0: release-notes/1.0.0.md
- Bounties:
- Bounties: bounties/index.md
- Bounty Sponsors Guide: bounties/sponsors.md
- Bounty Contributors Guide: bounties/contributors.md
- Lifecyle of a Bounty: bounties/lifecycle.md
- Bounty Pricing Guidance: bounties/prices.md
- Contribution Guidelines: developers/contributions.md
- Forking the Repository: developers/forking.md
- Discord Support Program: bounties/discord.md
- Bounties Board ↗️: https://github.com/orgs/hummingbot/projects/7/views/1
- Governance:
- Governance: governance/index.md
- Polls: governance/polls.md
- Proposals: governance/proposals.md
- Epochs: governance/epochs.md
- Whitepaper: governance/whitepaper.md
- About:
- About: about/index.md
- FAQ: faq.md
- Foundation: about/foundation.md
- Sponsors & Backers: about/sponsors.md
- Reported Volumes: reporting.md
- History: about/history.md
- 📆 Calendar ↗️: https://hummingbot-foundation.notion.site/5c767683f80b45c4934aa8cf755a2ff5?v=4dd057ac162f49c9813e11cec0688204
- Blog:
- blog/index.md