freqtrade_origin/mkdocs.yml

124 lines
3.8 KiB
YAML
Raw Normal View History

2018-12-28 13:52:23 +00:00
site_name: Freqtrade
2024-04-03 17:03:33 +00:00
site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://www.freqtrade.io/en/latest/']
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
2022-08-13 18:16:36 +00:00
edit_uri: edit/develop/docs/
use_directory_urls: True
2018-12-30 14:22:19 +00:00
nav:
- Home: index.md
2020-09-04 05:12:08 +00:00
- Quickstart with Docker: docker_quickstart.md
- Installation:
- Linux/MacOS/Raspberry: installation.md
- Windows: windows_installation.md
2020-06-14 09:38:56 +00:00
- Freqtrade Basics: bot-basics.md
2018-12-30 16:53:33 +00:00
- Configuration: configuration.md
2019-05-19 07:07:43 +00:00
- Strategy Customization: strategy-customization.md
2021-11-20 10:44:56 +00:00
- Strategy Callbacks: strategy-callbacks.md
2019-04-05 04:51:16 +00:00
- Stoploss: stoploss.md
2021-11-20 10:44:56 +00:00
- Plugins: plugins.md
2019-04-05 04:51:16 +00:00
- 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
2019-01-05 18:34:45 +00:00
- Backtesting: backtesting.md
- Hyperopt: hyperopt.md
- FreqAI:
- Introduction: freqai.md
2022-09-17 15:43:39 +00:00
- Configuration: freqai-configuration.md
- Parameter table: freqai-parameter-table.md
- Feature engineering: freqai-feature-engineering.md
2022-09-17 15:43:39 +00:00
- Running FreqAI: freqai-running.md
- Reinforcement Learning: freqai-reinforcement-learning.md
2022-09-11 15:50:50 +00:00
- Developer guide: freqai-developers.md
- Short / Leverage: leverage.md
- Utility Sub-commands: utils.md
2021-02-25 18:54:57 +00:00
- Plotting: plotting.md
- Exchange-specific Notes: exchanges.md
- Data Analysis:
- Jupyter Notebooks: data-analysis.md
- Strategy analysis: strategy_analysis_example.md
2022-04-22 04:38:51 +00:00
- Backtest analysis: advanced-backtesting.md
- Advanced Topics:
- Advanced Post-installation Tasks: advanced-setup.md
2022-12-18 19:02:38 +00:00
- 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
2024-07-13 07:49:09 +00:00
- Orderflow: advanced-orderflow.md
- Producer/Consumer mode: producer-consumer.md
- SQL Cheat-sheet: sql_cheatsheet.md
2022-07-22 05:22:01 +00:00
- Edge Positioning: edge.md
- FAQ: faq.md
- Strategy migration: strategy_migration.md
- Updating Freqtrade: updating.md
2019-09-30 18:36:52 +00:00
- Deprecated Features: deprecated.md
- Contributors Guide: developer.md
2018-12-28 14:37:14 +00:00
theme:
name: material
logo: "images/logo.png"
favicon: "images/logo.png"
custom_dir: "docs/overrides"
2022-09-11 11:28:14 +00:00
features:
2023-01-10 06:22:28 +00:00
- content.code.annotate
2022-09-11 11:28:14 +00:00
- search.share
- content.code.copy
- navigation.top
- navigation.footer
2018-12-28 14:37:14 +00:00
palette:
2021-06-24 20:53:46 +00:00
- scheme: default
primary: "blue grey"
accent: "tear"
2021-06-24 20:53:46 +00:00
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: "blue grey"
accent: "tear"
2021-06-24 20:53:46 +00:00
toggle:
icon: material/toggle-switch
name: Switch to light mode
2019-10-06 17:27:20 +00:00
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
2018-12-28 14:37:14 +00:00
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
2021-11-29 18:32:16 +00:00
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- mdx_truly_sane_lists
2024-08-20 18:17:31 +00:00
extra:
version:
provider: mike
2024-08-24 07:33:33 +00:00
alias: true
2024-08-20 18:17:31 +00:00
plugins:
- search:
enabled: true
2024-08-20 18:17:31 +00:00
- mike:
deploy_prefix: 'en'