-
-
Notifications
You must be signed in to change notification settings - Fork 6k
/
mkdocs.yml
126 lines (126 loc) · 3.9 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
site_name: Freqtrade
site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://www.freqtrade.io/en/']
site_description: Freqtrade is a free and open source crypto trading bot written in Python, designed to support all major exchanges and be controlled via Telegram or builtin Web UI
repo_url: https://github.com/freqtrade/freqtrade
edit_uri: edit/develop/docs/
use_directory_urls: True
nav:
- Home: index.md
- Quickstart with Docker: docker_quickstart.md
- Installation:
- Linux/MacOS/Raspberry: installation.md
- Windows: windows_installation.md
- Freqtrade Basics: bot-basics.md
- Configuration: configuration.md
- Strategy Customization: strategy-customization.md
- Strategy Callbacks: strategy-callbacks.md
- Stoploss: stoploss.md
- Plugins: plugins.md
- Start the bot: bot-usage.md
- Control the bot:
- Telegram: telegram-usage.md
- freqUI: freq-ui.md
- REST API: rest-api.md
- Web Hook: webhook-config.md
- Data Downloading: data-download.md
- Backtesting: backtesting.md
- Hyperopt: hyperopt.md
- FreqAI:
- Introduction: freqai.md
- Configuration: freqai-configuration.md
- Parameter table: freqai-parameter-table.md
- Feature engineering: freqai-feature-engineering.md
- Running FreqAI: freqai-running.md
- Reinforcement Learning: freqai-reinforcement-learning.md
- Developer guide: freqai-developers.md
- Short / Leverage: leverage.md
- Utility Sub-commands: utils.md
- Plotting: plotting.md
- Exchange-specific Notes: exchanges.md
- Data Analysis:
- Jupyter Notebooks: data-analysis.md
- Strategy analysis: strategy_analysis_example.md
- Backtest analysis: advanced-backtesting.md
- Advanced Topics:
- Advanced Post-installation Tasks: advanced-setup.md
- Trade Object: trade-object.md
- Lookahead analysis: lookahead-analysis.md
- Recursive analysis: recursive-analysis.md
- Advanced Strategy: strategy-advanced.md
- Advanced Hyperopt: advanced-hyperopt.md
- Orderflow: advanced-orderflow.md
- Producer/Consumer mode: producer-consumer.md
- SQL Cheat-sheet: sql_cheatsheet.md
- Edge Positioning: edge.md
- FAQ: faq.md
- Strategy migration: strategy_migration.md
- Updating Freqtrade: updating.md
- Deprecated Features: deprecated.md
- Contributors Guide: developer.md
theme:
name: material
logo: "images/logo.png"
favicon: "images/logo.png"
custom_dir: "docs/overrides"
features:
- content.code.annotate
- search.share
- content.code.copy
- navigation.top
- navigation.footer
palette:
- scheme: default
primary: "blue grey"
accent: "tear"
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: "blue grey"
accent: "tear"
toggle:
icon: material/toggle-switch
name: Switch to light mode
extra_css:
- "stylesheets/ft.extra.css"
extra_javascript:
- javascripts/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
markdown_extensions:
- attr_list
- admonition
- footnotes
- codehilite:
guess_lang: false
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.pathconverter
- pymdownx.smartsymbols
- pymdownx.snippets:
base_path: docs
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- mdx_truly_sane_lists
extra:
version:
provider: mike
alias: true
analytics:
provider: google
property: G-VH170LG9M5
plugins:
- search:
enabled: true
- mike:
deploy_prefix: 'en'