Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
127 lines (108 loc) · 4.47 KB
/
Copy pathmkdocs.yml
File metadata and controls
127 lines (108 loc) · 4.47 KB
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
# ==================== Site Metadata ====================
site_name: Intelligent Trading Bot
site_description: Documentation for the Intelligent Trading Bot
site_url: https://asavinov.github.io/intelligent-trading-bot/
site_author: Alexandr Savinov
# ==================== Repository Links ====================
repo_url: https://github.com/asavinov/intelligent-trading-bot
repo_name: asavinov/intelligent-trading-bot
#edit_uri: edit/main/docs/ # Allows "Edit this page" button on GitHub
# ==================== Navigation ====================
nav:
- Home: index.md
- Column-oriented design: column-oriented-design.md
- Features: features.md
- Labels: labels.md
- Trainable features: trainable-features.md
- Data inputs: data-inputs.md
- Outputs and trading: outputs-trader.md
- Configuration: configuration.md
- Server: server.md
- Scripts: scripts.md
# ==================== Theme Configuration ====================
theme:
name: material
features:
- toc.integrate
- navigation.tabs # Top navigation tabs (Home | Docs | Blog)
- navigation.tabs.sticky # Keep tabs visible while scrolling
- navigation.sections # Group pages under sections
- navigation.expand # Expand sections by default
- navigation.path # Show breadcrumb path
- navigation.indexes # Allow section landing pages (e.g., docs/index.md)
- navigation.top # "Back to top" button
#- navigation.hide
#- header.autohide # Hide header on scroll down
- content.code.copy # Copy button on code blocks
- content.action.edit # "Edit this page" link
- content.code.annotate # Uncomment for code annotations
- content.tabs.link # Linked content tabs
- search.suggest # Search suggestions
- search.highlight # Highlight search terms
- search.share
palette:
# Light / dark mode (you can add more schemes)
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/weather-sunny
name: Switch to light mode
icon:
repo: fontawesome/brands/github # GitHub icon in header
# favicon and logo (place these in docs/assets/images/)
# favicon: assets/images/favicon.png
# logo: assets/images/logo.svg
# ==================== Markdown Extensions ====================
markdown_extensions:
- admonition # note, warning, tip, etc.
- pymdownx.details # Collapsible admonitions
- pymdownx.superfences # For Mermaid diagrams, etc.
- pymdownx.highlight: # Better code highlighting
anchor_linenums: true
- pymdownx.tabbed: # Tabbed content
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
# - pymdownx.tasklist: # Uncomment for GitHub-style task lists
# custom_checkbox: true
- toc:
permalink: true
- attr_list # For custom attributes
- md_in_html # Markdown inside HTML
# ==================== Plugins ====================
plugins:
- search # Built-in fast search
# - rss: # Uncomment after `pip install mkdocs-rss-plugin`
# match_path: blog/.*\.md
# date_from_meta:
# as_creation: date
# as_update: date.updated
#- social: # Social cards (OG images for sharing)
# cards_layout_options:
# background_color: "#1E88E5"
# ==================== Extra Configuration ====================
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/asavinov
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/in/alexandrsavinov/
- icon: fontawesome/brands/twitter
link: https://twitter.com/asavinov
# analytics:
# provider: google
# property: G-XXXXXXXXXX # Your Google Analytics ID
# Optional: Versioning (uncomment when you need multiple versions)
# extra:
# version:
# provider: mike
# Copyright footer
copyright: Copyright © 2026 Alexandr Savinov - All rights reserved