forked from hummingbot/hummingbot
/
mkdocs.yml
115 lines (109 loc) · 3.16 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
# Project info
site_name: hummingbot docs
site_description: 'Docs for hummingbot, the open source crypto market making bot'
site_author: 'CoinAlpha, Inc.'
site_url: 'https://docs.hummingbot.io'
# Repository
repo_name: 'coinalpha/hummingbot'
repo_url: 'https://github.com/coinalpha/hummingbot'
edit_uri: 'blob/master/documentation/docs/'
# Copyright
copyright: 'Copyright © 2019 CoinAlpha, Inc.'
# Configuration
theme:
name: 'material'
logo: 'assets/img/logo.png'
favicon: 'assets/img/favicon.ico'
palette:
primary: 'teal'
accent: 'teal'
font:
text: 'Roboto'
code: 'Roboto Mono'
# Customization
extra:
search:
language: 'en'
social:
- type: 'globe'
link: 'https://www.hummingbot.io'
- type: 'github'
link: 'https://github.com/coinalpha/hummingbot'
- type: 'twitter'
link: 'https://twitter.com/hummingbot_io'
google_analytics:
- 'UA-119262087-3'
- 'auto'
extra_css:
- assets/css/custom.css
extra_javascript:
- assets/js/heap.js
# Extensions
markdown_extensions:
- admonition
- codehilite:
guess_lang: false
linenums: true
- toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Navigation
nav:
- Intro:
- Getting started: index.md
- FAQ: faq.md
- Whitepaper: whitepaper.md
- Roadmap: roadmap.md
- Terminology: glossary.md
- Installation:
- Installation: installation.md
- Install from Docker: installation/docker.md
- Install from source: installation/source.md
- Windows installation: installation/windows.md
- API keys: installation/api-keys.md
- Ethereum wallet: installation/wallet.md
- Ethereum node: installation/node.md
- Operation:
- Client: operation/client.md
- Configuration: operation/configuration.md
- Running bots: operation/running-bots.md
- Logging: operation/logging.md
- Exchange rates: operation/exchange-rates.md
- Debug console: operation/debug.md
- Connectors:
- Connectors: connectors.md
- Binance: connectors/binance.md
- Coinbase Pro: connectors/coinbase.md
- DDEX: connectors/ddex.md
- Radar Relay: connectors/radar-relay.md
- 0x open order book relayers: connectors/0x.md
- Strategies:
- Strategies: strategies.md
- Cross-exchange market making: strategies/cross-exchange-market-making.md
- Arbitrage: strategies/arbitrage.md
- Pure market making: strategies/pure-market-making.md
- Support:
- Support: support.md
- Bug bounty program: support/bug-bounty-program.md
- Known issues: support/issues.md
- Release notes:
- Release notes: release-notes.md
- 0.2.0: release-notes/0.2.0.md
- 0.3.0: release-notes/0.3.0.md
- 0.3.1 (beta): release-notes/0.3.1.md
- 0.4.0: release-notes/0.4.0.md