@@ -35,12 +35,17 @@ theme:
35
35
# Enable the copy button on code blocks
36
36
- content.code.copy
37
37
38
+ # Enables code selection button to link a specific section of a code block
39
+ - content.code.select
40
+
38
41
# Enable annotations in code blocks
39
42
- content.code.annotate
40
43
41
44
# Enable "view source" and "edit this page" buttons
42
45
- content.action.edit
43
46
# - content.action.view
47
+
48
+ # Enable tooltips (pop-open dialog boxes)
44
49
- content.tooltips
45
50
46
51
# Enable Navigation buttons in the footer (i.e. previous/next)
55
60
56
61
# Keeps tabs visible in the header when scrolling
57
62
- navigation.tabs.sticky
58
-
63
+
59
64
# Adds pop-up button just below the header (when the user starts to scroll up)
60
- # Allows users to easily jump to the beginning of the page
65
+ # i.e. Allows users to easily jump to the beginning of the page
61
66
- navigation.top
62
67
63
68
# Renders path for page navigation at the top of the page (makes page navigation more mobile friendly)
@@ -125,6 +130,7 @@ theme:
125
130
# Add custom admonitions
126
131
github : simple/github
127
132
arduino : simple/arduino
133
+ rpi : simple/raspberrypi
128
134
python : simple/python
129
135
code : fontawesome/regular/file-code
130
136
terminal : octicons/terminal-16
@@ -160,47 +166,60 @@ plugins:
160
166
# Provide domains for assets that are retrieved from external sites
161
167
assets_include :
162
168
- https://docs.sparkfun.com/*
163
-
169
+
164
170
# External links open in a new tab
165
171
links_attr_map :
166
172
target : _blank
167
173
links_noopener : true
168
174
169
- # # Optimizes media files (*.png and *.jpg)
170
- # - optimize:
171
- # # Specify directory; otherwise, multiple instances are created (.cache/plugins and .cache/plugin)
172
- # cache_dir: .cache/plugins/optimize
173
-
174
- # # Default values (from auto-complete)
175
- # # ------------------------------
176
- # # enabled: true
177
- # # cache: true
178
- # # cache_dir: .cache/plugins/optimize
179
- # # optimize_png: true
180
- # # optimize_png_speed: 4
181
- # # optimize_png_strip: true
182
- # # optimize_jpg: true
183
- # # optimize_jpg_quality: 60
184
- # # optimize_jpg_progressive: true
185
- # # print_gain: true
186
- # # print_gain_summary: true
187
-
188
-
189
- # # Add revision date
190
- # - git-revision-date-localized:
191
- # enable_creation_date: true
192
- # type: timeago
193
-
194
- # # Add git committers at the bottom of the page
195
- # - git-committers:
196
- # repository: sparkfun/SparkFun_LG290P_Quadband_GNSS_RTK_Breakout
197
- # branch: main
198
-
199
- # # Add git authors at the bottom of the page
200
- # - git-authors
175
+ # Optimizes media files (*.png and *.jpg)
176
+ - optimize :
177
+ # Disables plugin on local builds
178
+ enabled : !ENV [CI, false]
179
+
180
+ # Specify directory; otherwise, multiple instances are created (.cache/plugins and .cache/plugin)
181
+ cache_dir : .cache/plugins/optimize
182
+
183
+ # Default values (from auto-complete)
184
+ # ------------------------------
185
+ # enabled: true
186
+ # cache: true
187
+ # cache_dir: .cache/plugins/optimize
188
+ # optimize_png: true
189
+ # optimize_png_speed: 4
190
+ # optimize_png_strip: true
191
+ # optimize_jpg: true
192
+ # optimize_jpg_quality: 60
193
+ # optimize_jpg_progressive: true
194
+ # print_gain: true
195
+ # print_gain_summary: true
196
+
197
+
198
+ # Add revision date
199
+ - git-revision-date-localized :
200
+ # Disables plugin on local builds
201
+ enabled : !ENV [CI, false]
202
+
203
+ enable_creation_date : true
204
+ type : timeago
205
+
206
+ # Add git committers at bottom of the page
207
+ - git-committers :
208
+ # Disables plugin on local builds
209
+ enabled : !ENV [CI, false]
210
+
211
+ repository : sparkfun/SparkFun_RTK_mosaic-X5
212
+ branch : main
213
+
214
+ # Add git authors at bottom of the page
215
+ - git-authors :
216
+ # Disables plugin on local builds
217
+ enabled : !ENV [CI, false]
201
218
202
219
# Enables use of Git submodules and larger code base
203
- # - monorepo
220
+ - monorepo :
221
+ # Disables plugin on local builds
222
+ enabled : !ENV [CI, false]
204
223
205
224
206
225
# Included Markdown extensions
@@ -221,10 +240,10 @@ markdown_extensions:
221
240
url_request_headers : {}
222
241
dedent_subsections : True
223
242
224
- # Adds support for glossary of abbreviations
243
+ # Adds support for a glossary of abbreviations
225
244
auto_append :
226
- - glossary-sparkfun.md
227
245
# - https://raw.githubusercontent.com/santaimpersonator/git-test/main/glossary-sparkfun.md
246
+ - glossary-sparkfun.md
228
247
- glossary-local.md
229
248
230
249
# Allows embedding of code blocks in other elements
@@ -283,7 +302,7 @@ markdown_extensions:
283
302
# Allows the use of abbreviations
284
303
- abbr
285
304
286
- # Allows the use of bundled and custom icons/ emojis
305
+ # Allows the use of bundled and custom icons and emojis
287
306
- pymdownx.emoji :
288
307
emoji_index : !!python/name:material.extensions.emoji.twemoji
289
308
emoji_generator : !!python/name:material.extensions.emoji.to_svg
@@ -294,7 +313,7 @@ markdown_extensions:
294
313
# Allows for the rendering of block and inline-block equations
295
314
- pymdownx.arithmatex :
296
315
generic : true
297
-
316
+
298
317
# Adds permalink icon to headers
299
318
- toc :
300
319
permalink : ' '
@@ -320,12 +339,28 @@ extra:
320
339
link : https://www.facebook.com/SparkFun
321
340
- icon : fontawesome/brands/x-twitter
322
341
link : https://twitter.com/sparkfun
342
+ - icon : fontawesome/solid/cookie-bite
343
+ link : /#__consent
344
+ name : Change cookie settings
323
345
324
- # Google Analytics
346
+ # Configures Google Analytics
325
347
analytics :
326
348
provider : google
327
349
property : G-7Y7EYCZVC1
328
350
351
+ consent :
352
+ cookies :
353
+ analytics :
354
+ name : Google Analytics
355
+ checked : true
356
+ title : Cookie consent
357
+ description :
358
+ We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.
359
+ actions :
360
+ - accept
361
+ - manage
362
+ - reject
363
+
329
364
330
365
# Configures styling for the webpage
331
366
extra_css :
@@ -350,6 +385,7 @@ exclude_docs: |
350
385
not_in_nav : |
351
386
index.md
352
387
print_view.md
388
+ favicon.ico
353
389
354
390
# Webpage navigation tabs
355
391
nav :
0 commit comments