-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
194 lines (166 loc) · 5.49 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
site_name: SparkFun 6DoF - LSM6DSV16X (Qwiic) Hookup Guide
site_description: A hookup guide for the SparkFun Development Board Board
site_url: https://sparkfun.github.io/SparkFun_6DoF_LSM6DSV16X/
edit_uri: blob/docs/
repo_url: https://github.com/sparkfun/SparkFun_6DoF_LSM6DSV16X
repo_name: sparkfun/SparkFun_6DoF_LSM6DSV16X/
copyright:
Copyright 2023 - <a href="https://www.sparkfun.com/" target="_blank" rel="noopener">SparkFun Electronics®<br>
<a href="https://goo.gl/maps/vkstCpQZW6jZMjzYA" target="_blank" rel="noopener">6333 Dry Creek Parkway, Niwot, Colorado 80503</a>
# Configuration for webpage theme
theme:
name: material
logo: assets/sfe_logo_sm.png
favicon: assets/favicon.png
font:
text: Roboto
code: Roboto Mono
features:
# Enable copy button on code blocks
- content.code.copy
# Enable annotations in code blocks
- content.code.annotate
# Enable "view source" and "edit this page" buttons
- content.action.edit
# - content.action.view
# Enable Navigation buttons in the footer (i.e. previous/next)
- navigation.footer
# Enables anchor tracking (updates page url with the section user is on)
# i.e. https://docs.sparkfun.com/<page link>/#<sub-section>
- navigation.tracking
- navigation.tabs.sticky
# Enables tabs for navigating the website
- navigation.tabs
# Keeps tabs visible in the header when scrolling
- navigation.tabs.sticky
# Adds pop-up button just below the header (when the user starts to scroll up)
# Allows users to easily jump to the beginning of the page
- navigation.top
# Renders path for page navigation at top of the page (makes page navigation more mobile friendly)
- navigation.path
# Adds light/dark theme to webpage
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: grey
accent: red
toggle:
icon: material/brightness-auto
name: Switch to dark mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
primary: grey
accent: red
scheme: default
toggle:
icon: material/brightness-7
name: Switch to system preference
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
primary: grey
accent: red
scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
icon:
# Sets repo icon to GitHub icon
repo: fontawesome/brands/github
# Sets icons for "view source" (commented out) and "edit this page" buttons
edit: material/file-document-edit-outline
# view: material/file-code-outline
# Admonition Icons
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: simple/sparkfun
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
# Add custom admonitions
github: simple/github
arduino: simple/arduino
python: simple/python
code: fontawesome/regular/file-code
terminal: octicons/terminal-16
serial: fontawesome/solid/display
# Permalink icon
link: octicons/link-16
# Adds PDF icon to download hookup guide
custom_dir: docs/overrides
# Included MkDocs plugins
# Add the installation of any new plugins to the ./github/workflows/mkdocs.yml file also
plugins:
- search
- monorepo
# For PDF rendering
# - with-pdf:
# cover_subtitle: none
# cover_logo: assets/img/sfe_logo_sm.png
# exclude_pages: [ "print_pdf", "file_issue", "contribute" ]
# output_path: assets/SparkFun_6DoF_LSM6DSV16X-hookup_guide.pdf
# Included Markdown extensions
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets:
# base_path: ['./docs']
url_download: true
url_max_size: 0
url_timeout: 0
url_request_headers: {}
- pymdownx.superfences
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.mark
- pymdownx.caret
- pymdownx.tilde
- pymdownx.keys
- tables
- admonition
- md_in_html
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
extra:
social:
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/sparkfun
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/sparkfun
- icon: fontawesome/brands/github
link: https://www.github.com/sparkfun
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/SparkFun
- icon: fontawesome/brands/twitter
link: https://twitter.com/sparkfun
# Configures styling for PDF rendering and webpage layout
extra_css:
- overrides/extra.css
nav:
- Hookup Guide:
- Introduction: index.md
- Hardware Overview: hardware_overview.md
- Hardware Assembly: hardware_assembly.md
- Software Setup and Programming: software_setup_and_programming.md
- Examples: examples.md
- Hardware Resources:
- Resources: resources_and_going_further.md
- Support:
- Troubleshooting: troubleshooting.md
- Issues: file_issue.md
- Contributing: contribute.md