-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
223 lines (190 loc) · 6.84 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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
site_name: DFR Technical Wiki
site_url: https://dallasformularacing.wiki.com/
repo_name: DallasFormulaRacing/
repo_url: https://github.com/DallasFormulaRacing/
docs_dir: wiki-site/docs
copyright: Copyright © 2023 - 2024 Dallas Formula Racing
theme:
name: material
features:
- navigation.instant
- navigation.tracking
- navigation.tabs
# - navigation.sections
- navigation.path
- navigation.indexes
- navigation.footer
- navigation.top
- search.highlight
- search.share
- search.suggest
- toc.follow
- content.code.copy
- content.code.select
logo: assets/resized-Cropped-white-logo-DFR.png
favicon: assets/cropped-Logo-Updated-PNG-1.webp
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: teal
accent: deep orange
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: deep orange
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
accent: deep orange
toggle:
icon: material/weather-night
name: Switch to system preference
icon:
admonition:
note: material/pencil
abstract: octicons/checklist-16
info: octicons/info-16
tip: material/speedometer
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
repo: fontawesome/brands/github
markdown_extensions:
# Admonitions (Call-outs)
- admonition
- pymdownx.details
- pymdownx.superfences
# Annotations, Buttons, Grids, and Images
- attr_list
- md_in_html
# Code Blocks. Content Tabs, and Toolti[s]
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
# Tables
- tables
# Mermaid Diagrams
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# Footnotes
- footnotes
# Formatting
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
# Icons and emojis
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
# Lists
- def_list
- pymdownx.tasklist:
custom_checkbox: true
# Math via Katex
- pymdownx.arithmatex:
generic: true
extra_javascript:
- javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
plugins:
- search
- glightbox
- git-revision-date-localized
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/DallasFormulaRacing
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/dallas-formula-racing
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/dallasformularacing/
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/dallasformularacing
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/dallasformula
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@dallasformularacing3979
nav:
- Home: index.md
- Data Acquisition:
- Data Acquisition/index.md
- Developer's Guide:
- Data Acquisition/Dev Guide/index.md
- Code Editors: Data Acquisition/Dev Guide/code-editors.md
- Build, Flash, and Debug: Data Acquisition/Dev Guide/build-flash-debug.md
- Viewing Serial Output: Data Acquisition/Dev Guide/view-serial-output.md
- Viewing RTOS Threads, Queues, and Memory: Data Acquisition/Dev Guide/view-threads-queues-memory.md
- Unit Testing: Data Acquisition/Dev Guide/unit-testing.md
- Source Code Docs: Data Acquisition/Dev Guide/source-code-docs.md
- Contributing and Version Control: Data Acquisition/Dev Guide/contributing-version-control.md
- Style Guide: Data Acquisition/Dev Guide/style-guide.md
- Code Generator Configs: Data Acquisition/Dev Guide/code-generator-configs.md
- Enabling printf: Data Acquisition/Dev Guide/enabling-printf.md
- Enabling C++: Data Acquisition/Dev Guide/enabling-cpp.md
- Firmware Design:
- Data Acquisition/Firmware Design/index.md
- Architecture Overview: Data Acquisition/Firmware Design/architecture-overview.md
- File Structure: Data Acquisition/Firmware Design/file-structure.md
- Timing and Concurrency: Data Acquisition/Firmware Design/timing-and-concurrency.md
- Data Logging:
- Data Acquisition/Application/Data Logger/data_payload.md
- Data Acquisition/Application/Data Logger/circular_queue.md
- Data Acquisition/Application/Data Logger/data_logger.md
- Data Acquisition/Application/RTOS Components/mutex.md
- File System:
- Data Acquisition/Application/File System/index.md
- Data Acquisition/Application/File System/fat_fs.md
- Engine Controll Unit (ECU):
- Data Acquisition/Sensor/ECU/index.md
- Data Acquisition/Sensor/ECU/pe3.md
- Suspension Travel Potentiometers:
- Data Acquisition/Sensor/Linear Potentiometer/index.md
- Data Acquisition/Sensor/Linear Potentiometer/SLS_1322-3.md
- Accelerometer:
- Data Acquisition/Sensor/Accelerometer/index.md
- Data Acquisition/Sensor/Accelerometer/lsm303dlhc.md
- Gyroscope:
- Data Acquisition/Sensor/Gyroscope/index.md
- Data Acquisition/Sensor/Gyroscope/l3gd20h.md
- Supported Platforms:
- Data Acquisition/Supported Platforms/index.md
- Data Acquisition/Supported Platforms/STMicroelectronics/stmicroelectronics.md
- Custom DAQ PCB Boards:
- Data Acquisition/Custom DAQ PCB Boards/index.md
- Data Acquisition/Custom DAQ PCB Boards/DAQ Revision 1/Revision 1.md
- Dashboard Display:
- Dashboard Display/index.md
- Developer's Guide:
- Dashboard Display/Dev Guide/index.md
- Dashboard Display/Dev Guide/os-flashing-tools.md
- Dashboard Display/Dev Guide/starter-package.md
- Dashboard Display/Dev Guide/terminal-and-serial.md
- Dashboard Display/Dev Guide/developer-package.md
- Dashboard Display/Dev Guide/running-qt5-apps.md