forked from hummingbot/hummingbot-site
-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
402 lines (393 loc) · 15 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
# Project info
site_name: Hummingbot Docs
site_description: The official documentation for Hummingbot
site_author: Hummingbot Foundation
site_url: https://docs.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 © 2022 Hummingbot Foundation
# Configuration
theme:
name: material
logo: assets/img/logo.png
favicon: assets/img/favicon.ico
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: cyan
accent: purple
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: cyan
accent: purple
toggle:
icon: material/toggle-switch
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
features:
- navigation.instant
- navigation.tracking
# - navigation.tabs
# - navigation.tabs.sticky
- navigation.indexes
- navigation.top
plugins:
- search
- git-revision-date
- social:
cards_color:
fill: rgb(40, 47, 56)
text: white
extra:
homepage: https://docs.hummingbot.org
generator: false
analytics:
provider: google
property: UA-119262087-3
social:
- icon: fontawesome/solid/envelope
link: https://hummingbot.substack.com
- icon: fontawesome/brands/discord
link: https://discord.gg/hummingbot
- icon: fontawesome/brands/twitter
link: https://twitter.com/hummingbot_org
- icon: fontawesome/brands/github
link: https://github.com/hummingbot/hummingbot
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/hummingbot/hummingbot
extra_css:
- assets/css/custom.css
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
- assets/js/tables.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- assets/js/config.js
# - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS-MML_HTMLorMML
# Extensions
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- pymdownx.arithmatex:
generic: true
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
user: hummingbot
repo: hummingbot
repo_url_shorthand: true
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
auto_append:
- includes/abbreviations.md
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- toc:
permalink: true
# Navigation
nav:
- Docs:
- Docs: index.md
- Installation:
- Installation: installation/index.md
- Deploying Hummingbot with Docker: installation/deploy.md
- Installing Hummingbot on Linux: installation/linux.md
- Installing Hummingbot on MacOS: installation/mac.md
- Installing Hummingbot on Windows: installation/windows.md
- Installing Hummingbot on Raspberry Pi: installation/raspberry-pi.md
- Running Multiple Hummingbot Instances: installation/multiple-bots.md
- Quickstart:
- Quickstart: quickstart/index.md
- Exercise 1 - Hello World: quickstart/custom-pmm-1.md
- Exercise 2 - Simple PMM: quickstart/custom-pmm-2.md
- Exercise 3 - Customize Status: quickstart/custom-pmm-3.md
- Exercise 4 - Basic Price Ceiling/Floor: quickstart/custom-pmm-4.md
- Exercise 5 - Dynamic Price Ceiling/Floor: quickstart/custom-pmm-5.md
- Features:
- Features: operation/index.md
- User Interface Guide: operation/user-interface.md
- Commands and Shortcuts: operation/commands-shortcuts.md
- Launch/Exit Hummingbot: operation/launch-exit.md
- Create/Delete Password: operation/password.md
- Connect Exchange API Keys: operation/connect.md
- Create/Import Config Files: operation/config-files.md
- Check Balances: operation/balance.md
- Start/Stop Strategy: operation/start-stop.md
- Check Bot/Market Status: operation/status.md
- Check Performance: operation/history.md
- Find Log Files: operation/log-files.md
- Export Trades/Keys: operation/export.md
- Advanced Features:
- Advanced Features: global-configs/index.md
- Auto-start from Command Line: global-configs/strategy-autostart.md
- Balance Limit: global-configs/balance-limit.md
- Clock Tick Size: global-configs/clock-tick.md
- Color Settings: global-configs/color-settings.md
- Connect External Database: global-configs/external-db.md
- Kill Switch: global-configs/kill-switch.md
- Override Fees: global-configs/override-fees.md
- Paper Trade: global-configs/paper-trade.md
- Rate Oracle: strategy-configs/rate-oracle.md
- Rate Limits Share Pct: global-configs/rate-limits-share-pct.md
- Telegram Integration: global-configs/telegram.md
- PMM Configs:
- PMM 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
- Scripts:
- Scripts: scripts/index.md
- Script Examples: scripts/examples.md
- Cheatsheet: scripts/cheatsheet.md
- Candles Feed: scripts/candles-feed.md
- Smart Components: scripts/smart-components.md
- PMM Scripts: scripts/pmm-scripts.md
- Exchanges:
- Exchange Connectors: exchanges/index.md
- Gold:
- Binance: exchanges/binance.md
- Binance (perp): exchanges/binance-perpetual.md
- Uniswap: exchanges/uniswap.md
- Silver:
- Kucoin: exchanges/kucoin.md
- Kucoin (perp): exchanges/kucoin-perpetual.md
- Gate.io: exchanges/gate-io.md
- Gate.io (perp): exchanges/gate-io-perpetual.md
- AscendEX: exchanges/ascend-ex.md
- Pancakeswap: exchanges/pancakeswap.md
- Sushiswap: exchanges/sushiswap.md
- dYdX: exchanges/dydx-perpetual.md
- Bronze CEX:
- AltMarkets: exchanges/altmarkets.md
- Binance US: exchanges/binance-us.md
- Bybit: exchanges/bybit.md
- Bybit (perp): exchanges/bybit-perpetual.md
- Bitfinex: exchanges/bitfinex.md
- BitGet: exchanges/bitget-perpetual.md
- BitMart: exchanges/bitmart.md
- Bitmex: exchanges/bitmex.md
- Bitmex (perp): exchanges/bitmex-perpetual.md
- Bittrex: exchanges/bittrex.md
- BTC-Markets: exchanges/btc-markets.md
- CI-EX: exchanges/ci-ex.md
- Coinbase: exchanges/coinbase.md
- Crypto.com : exchanges/crypto-com.md
- HitBTC: exchanges/hitbtc.md
- Huobi: exchanges/huobi.md
- Kraken: exchanges/kraken.md
- LBank: exchanges/lbank.md
- Loopring: exchanges/loopring.md
- MEXC: exchanges/mexc.md
- NDAX: exchanges/ndax.md
- OKX: exchanges/okx.md
- ProBit: exchanges/probit.md
- WhiteBit: exchanges/whitebit.md
- Bronze DEX:
- DeFi Kingdoms: exchanges/defikingdoms.md
- Defira: exchanges/defira.md
- Dexalot: exchanges/dexalot.md
- Injective: exchanges/injective.md
- Mad Meerkat: exchanges/mad-meerkat.md
- OpenOcean: exchanges/openocean.md
- Pangolin: exchanges/pangolin.md
- Perpetual Protocol: exchanges/perp.md
- Quickswap: exchanges/quickswap.md
- Ref: exchanges/ref.md
- TraderJoe: exchanges/traderjoe.md
- VVS: exchanges/vvs.md
- XSwap: exchanges/xswap.md
- Strategies:
- Strategies: strategies/index.md
- Core:
- Pure Market Making: strategies/pure-market-making.md
- Cross-Exchange Market Making: strategies/cross-exchange-market-making.md
- AMM Arbitrage: strategies/amm-arbitrage.md
- Community:
- Aroon Oscillator: strategies/aroon-oscillator.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
- Uniswap v3 LP: strategies/uniswap-v3-lp.md
- Gateway:
- Gateway: gateway/index.md
- Installation: gateway/installation.md
- Testing Gateway: gateway/testing.md
- Using Gateway with Hummingbot: gateway/setup.md
- Working with Tokens: gateway/tokens.md
- Running DEX Bots: gateway/running-dex-bots.md
- Adding DEX Connectors: gateway/adding-dex-connectors.md
- API Reference: gateway/api-reference.md
- Chains:
- Chains: chains/index.md
- Ethereum: chains/ethereum.md
- Avalanche: chains/avalanche.md
- BNB Chain: chains/bnb-chain.md
- Cronos: chains/cronos.md
- Cosmos: chains/cosmos.md
- Harmony: chains/harmony.md
- NEAR: chains/near.md
- Polygon: chains/polygon.md
- XDC Chain: chains/xdc-chain.md
- FAQ: faq.md
- Troubleshooting: troubleshooting.md
- Glossary: glossary.md
- ❤️ Support Hummingbot!: support-hummingbot.md
- Developers:
- Developers: developers/index.md
- Contribution Guidelines: developers/contributions.md
- Debug Console: developers/debug.md
- Building CEX Connectors:
- Building CEX Connectors: developers/connectors/index.md
- Architecture: developers/connectors/architecture/index.md
- Order Lifecycle and Market Events: developers/connectors/architecture/order_lifecycle.md
- API Throttler: developers/connectors/architecture/api_throttler.md
- Build Process: developers/connectors/build.md
- QA Testing Process: developers/connectors/test.md
- Debugging: developers/connectors/debug.md
- Building DEX Connectors: gateway/adding-dex-connectors.md
- Building Strategies:
- Building Strategies: developers/strategies/index.md
- Architecture: developers/strategies/architecture.md
- Tutorial: developers/strategies/tutorial.md
- Key Concepts: developers/strategies/key-concepts.md
- Define Configs: developers/strategies/config.md
- Hanging Orders Tracker: developers/strategies/hanging-orders.md
- Adding Commands: developers/commands.md
- Governance:
- Governance: governance/index.md
- Whitepaper: governance/whitepaper.md
- Proposals: governance/proposals.md
- Polls: governance/polls.md
- Bounties: governance/bounties.md
- Releases: governance/releases.md
- Epochs: governance/epochs.md
- About Us:
- About Us: about/index.md
- Board of Directors: governance/board.md
- Community: community.md
- Reporting: reporting.md
- History: about/history.md
- Releases:
- Releases: release-notes/index.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
- 0.46.0: release-notes/0.46.0.md
- 0.45.0: release-notes/0.45.0.md
- 0.44.0: release-notes/0.44.0.md
- 0.43.1: release-notes/0.43.1.md
- 0.43.0: release-notes/0.43.0.md
- 0.42.0: release-notes/0.42.0.md
- 0.41.0: release-notes/0.41.0.md
- 0.40.0: release-notes/0.40.0.md
- 0.39.1: release-notes/0.39.1.md
- 0.39.0: release-notes/0.39.0.md
- 0.38.1: release-notes/0.38.1.md
- 0.38.0: release-notes/0.38.0.md
- 0.37.1: release-notes/0.37.1.md
- 0.37.0: release-notes/0.37.0.md
- 0.36.0: release-notes/0.36.0.md
- 0.35.0: release-notes/0.35.0.md
- 0.34.0: release-notes/0.34.0.md
- 0.33.1: release-notes/0.33.1.md
- 0.33.0: release-notes/0.33.0.md
- 0.32.0: release-notes/0.32.0.md
- 0.31.0: release-notes/0.31.0.md
- 0.30.0: release-notes/0.30.0.md
- 0.29.0: release-notes/0.29.0.md
- 0.28.1: release-notes/0.28.1.md
- 0.28.0: release-notes/0.28.0.md
- 0.27.0: release-notes/0.27.0.md
- 0.26.1: release-notes/0.26.1.md
- 0.26.0: release-notes/0.26.0.md
- 0.25.0: release-notes/0.25.0.md
- 0.24.1: release-notes/0.24.1.md
- 0.24.0: release-notes/0.24.0.md
- 0.23.0: release-notes/0.23.0.md
- 0.22.0: release-notes/0.22.0.md
- 0.21.0: release-notes/0.21.0.md
- 0.20.0: release-notes/0.20.0.md
- 0.19.1: release-notes/0.19.1.md
- 0.19.0: release-notes/0.19.0.md
- 0.18.1: release-notes/0.18.1.md
- 0.18.0: release-notes/0.18.0.md
- 0.17.1: release-notes/0.17.1.md
- 0.17.0: release-notes/0.17.0.md
- 0.16.0: release-notes/0.16.0.md
- 0.15.0: release-notes/0.15.0.md
- 0.14.0: release-notes/0.14.0.md
- 0.13.0: release-notes/0.13.0.md
- 0.12.1: release-notes/0.12.1.md
- 0.12.0: release-notes/0.12.0.md
- 0.11.1: release-notes/0.11.1.md
- 0.11.0: release-notes/0.11.0.md
- 0.10.1: release-notes/0.10.1.md
- 0.10.0: release-notes/0.10.0.md
- 0.9.1: release-notes/0.9.1.md
- 0.9.0: release-notes/0.9.0.md
- 0.8.1: release-notes/0.8.1.md
- 0.8.0: release-notes/0.8.0.md
- 0.7.0: release-notes/0.7.0.md
- 0.6.0: release-notes/0.6.0.md
- 0.5.1: release-notes/0.5.1.md
- 0.5.0: release-notes/0.5.0.md
- 0.4.0: release-notes/0.4.0.md
- 0.3.1: release-notes/0.3.1.md
- 0.3.0: release-notes/0.3.0.md
- 0.2.0: release-notes/0.2.0.md