freqtrade_origin/mkdocs.yml

site_name: Freqtrade
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
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'
changing doc theme 2018-12-28 13:52:23 +00:00			`site_name: Freqtrade`
use dynamic build process for RTD 2024-04-03 17:03:33 +00:00			`site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://www.freqtrade.io/en/latest/']`
Add site_description to docs for better SEO 2024-06-03 04:50:56 +00:00			`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`
Update styles to work with new mkdocs version 2021-03-01 08:35:35 +00:00			`repo_url: https://github.com/freqtrade/freqtrade`
Fix docs edit button 2022-08-13 18:16:36 +00:00			`edit_uri: edit/develop/docs/`
Version pin mkdocs to avoid nasty surprises fix use_directory_urls defaulting to false 2021-06-07 18:19:48 +00:00			`use_directory_urls: True`
restructuring docs content 2018-12-30 14:22:19 +00:00			`nav:`
Update install-script documentation and reorder installation steps 2020-02-24 19:11:25 +00:00			`- Home: index.md`
Rename files to have clearer paths 2020-09-04 05:12:08 +00:00			`- Quickstart with Docker: docker_quickstart.md`
			`- Installation:`
Address issue #2487 Breakdown insllation instructions Make installation instructions shorter Separate Windows from the remainder Use tabs for better navigation Minor language improvements 2020-09-03 02:37:45 +00:00			`- Linux/MacOS/Raspberry: installation.md`
			`- Windows: windows_installation.md`
Add bot basics documentation 2020-06-14 09:38:56 +00:00			`- Freqtrade Basics: bot-basics.md`
about document enriched 2018-12-30 16:53:33 +00:00			`- Configuration: configuration.md`
Rename strategy customization file 2019-05-19 07:07:43 +00:00			`- Strategy Customization: strategy-customization.md`
Extract callbacks into a separate site 2021-11-20 10:44:56 +00:00			`- Strategy Callbacks: strategy-callbacks.md`
Improve docs layout 2019-04-05 04:51:16 +00:00			`- Stoploss: stoploss.md`
Extract callbacks into a separate site 2021-11-20 10:44:56 +00:00			`- Plugins: plugins.md`
Improve docs layout 2019-04-05 04:51:16 +00:00			`- Start the bot: bot-usage.md`
			`- Control the bot:`
			`- Telegram: telegram-usage.md`
Make sure freqUI is visible in the menu 2024-05-03 04:42:58 +00:00			`- freqUI: freq-ui.md`
			`- REST API: rest-api.md`
Update styles to work with new mkdocs version 2021-03-01 08:35:35 +00:00			`- Web Hook: webhook-config.md`
Rename section to data-downloading, implement some feedback 2019-09-24 04:56:19 +00:00			`- Data Downloading: data-download.md`
fix typo, improve doc sequence 2019-01-05 18:34:45 +00:00			`- Backtesting: backtesting.md`
			`- Hyperopt: hyperopt.md`
reorganize freqai docs for easier reading, add detailed file structure description 2022-09-11 15:29:14 +00:00			`- FreqAI:`
			`- Introduction: freqai.md`
Reorganise multipage doc 2022-09-17 15:43:39 +00:00			`- Configuration: freqai-configuration.md`
			`- Parameter table: freqai-parameter-table.md`
reorganize freqai docs for easier reading, add detailed file structure description 2022-09-11 15:29:14 +00:00			`- Feature engineering: freqai-feature-engineering.md`
Reorganise multipage doc 2022-09-17 15:43:39 +00:00			`- Running FreqAI: freqai-running.md`
add reinforcement learning page to docs 2022-10-01 15:50:05 +00:00			`- Reinforcement Learning: freqai-reinforcement-learning.md`
add a developers guide 2022-09-11 15:50:50 +00:00			`- Developer guide: freqai-developers.md`
Update documentation structure, add links to migration page 2022-03-31 04:53:33 +00:00			`- Short / Leverage: leverage.md`
Small doc-reorg adding "advanced topics" as main header 2021-02-02 19:03:01 +00:00			`- Utility Sub-commands: utils.md`
Small enhancements to docs 2021-02-25 18:54:57 +00:00			`- Plotting: plotting.md`
Properly close parenteses in exchange doc 2021-09-03 14:18:47 +00:00			`- Exchange-specific Notes: exchanges.md`
Automatically generate documentation from jupyter notebook 2019-09-21 08:27:43 +00:00			`- Data Analysis:`
			`- Jupyter Notebooks: data-analysis.md`
			`- Strategy analysis: strategy_analysis_example.md`
Add doc-page to index 2022-04-22 04:38:51 +00:00			`- Backtest analysis: advanced-backtesting.md`
Small doc-reorg adding "advanced topics" as main header 2021-02-02 19:03:01 +00:00			`- Advanced Topics:`
			`- Advanced Post-installation Tasks: advanced-setup.md`
Move trade docs to advanced section 2022-12-18 19:02:38 +00:00			`- Trade Object: trade-object.md`
move lookahead and recursive docs under Advanced Topics 2023-09-24 05:28:18 +00:00			`- Lookahead analysis: lookahead-analysis.md`
			`- Recursive analysis: recursive-analysis.md`
Improve sorting in docs (these are more important than advanced strategy/docs) 2023-09-28 18:48:47 +00:00			`- Advanced Strategy: strategy-advanced.md`
			`- Advanced Hyperopt: advanced-hyperopt.md`
docs: Improve orderflow documentation 2024-07-13 07:49:09 +00:00			`- Orderflow: advanced-orderflow.md`
Update "branding" to producer/follower mode 2022-09-22 19:08:06 +00:00			`- Producer/Consumer mode: producer-consumer.md`
Move SQL Cheat-sheet into Advanced section most options are better suited in other ways now. 2024-05-19 07:03:31 +00:00			`- SQL Cheat-sheet: sql_cheatsheet.md`
Reorder advanced topics 2022-07-22 05:22:01 +00:00			`- Edge Positioning: edge.md`
Small doc-reorg adding "advanced topics" as main header 2021-02-02 19:03:01 +00:00			`- FAQ: faq.md`
Update documentation structure, add links to migration page 2022-03-31 04:53:33 +00:00			`- Strategy migration: strategy_migration.md`
Add updating documentation closes #4036 2020-12-04 18:59:26 +00:00			`- Updating Freqtrade: updating.md`
Docs adjusted, utils.md added 2019-09-30 18:36:52 +00:00			`- Deprecated Features: deprecated.md`
			`- Contributors Guide: developer.md`
added theme configuration 2018-12-28 14:37:14 +00:00			`theme:`
			`name: material`
updated mkdocs and leverage docs Added tests for set_liquidation_price and set_stop_loss updated params in interestmode enum 2021-07-13 01:39:35 +00:00			`logo: "images/logo.png"`
			`favicon: "images/logo.png"`
			`custom_dir: "docs/overrides"`
add search share button to website 2022-09-11 11:28:14 +00:00			`features:`
Add FreqAI migration documentation 2023-01-10 06:22:28 +00:00			`- content.code.annotate`
add search share button to website 2022-09-11 11:28:14 +00:00			`- search.share`
Add some feature flags for mkdocs migration 2023-01-09 06:24:18 +00:00			`- content.code.copy`
			`- navigation.top`
			`- navigation.footer`
added theme configuration 2018-12-28 14:37:14 +00:00			`palette:`
Add Dark theme to Documentation 2021-06-24 20:53:46 +00:00			`- scheme: default`
updated mkdocs and leverage docs Added tests for set_liquidation_price and set_stop_loss updated params in interestmode enum 2021-07-13 01:39:35 +00:00			`primary: "blue grey"`
			`accent: "tear"`
Add Dark theme to Documentation 2021-06-24 20:53:46 +00:00			`toggle:`
			`icon: material/toggle-switch-off-outline`
			`name: Switch to dark mode`
			`- scheme: slate`
updated mkdocs and leverage docs Added tests for set_liquidation_price and set_stop_loss updated params in interestmode enum 2021-07-13 01:39:35 +00:00			`primary: "blue grey"`
			`accent: "tear"`
Add Dark theme to Documentation 2021-06-24 20:53:46 +00:00			`toggle:`
📝 `mkdocs.yml` - Fixed darktheme toggle 2021-10-16 22:14:09 +00:00			`icon: material/toggle-switch`
			`name: Switch to light mode`
Add versions to doc theme 2019-10-06 17:27:20 +00:00			`extra_css:`
updated mkdocs and leverage docs Added tests for set_liquidation_price and set_stop_loss updated params in interestmode enum 2021-07-13 01:39:35 +00:00			`- "stylesheets/ft.extra.css"`
Updating Edge Positioning Doc. Integrated MathJax Included worked out examples Changed Language to achieve a middle ground. Minor formatting improvements 2020-09-02 22:58:54 +00:00			`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`
added theme configuration 2018-12-28 14:37:14 +00:00			`markdown_extensions:`
Update styles to work with new mkdocs version 2021-03-01 08:35:35 +00:00			`- 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`
Update mkdocs file to 8.0 2021-11-29 18:32:16 +00:00			`- pymdownx.tabbed:`
			`alternate_style: true`
Update styles to work with new mkdocs version 2021-03-01 08:35:35 +00:00			`- pymdownx.tasklist:`
			`custom_checkbox: true`
Reduce code complexity by combining buy and buy_fill methods 2021-11-30 18:45:20 +00:00			`- pymdownx.tilde`
Update styles to work with new mkdocs version 2021-03-01 08:35:35 +00:00			`- mdx_truly_sane_lists`
chore: add mike to mkdocs config 2024-08-20 18:17:31 +00:00			`extra:`
			`version:`
			`provider: mike`
docs: Show version alias on versions 2024-08-24 07:33:33 +00:00			`alias: true`
chore: re-add analytics to docs page 2024-09-04 18:44:15 +00:00			`analytics:`
			`provider: google`
			`property: G-VH170LG9M5`
chore: add mike to mkdocs config 2024-08-20 18:17:31 +00:00			`plugins:`
docs: re-establish search box on develop documentation 2024-08-28 18:27:16 +00:00			`- search:`
			`enabled: true`
chore: add mike to mkdocs config 2024-08-20 18:17:31 +00:00			`- mike:`
			`deploy_prefix: 'en'`