Skip to content

Commit 03ad14b

Browse files
Update mkdocs.yml
Update to recent changes
1 parent 2cebf92 commit 03ad14b

File tree

1 file changed

+77
-41
lines changed

1 file changed

+77
-41
lines changed

mkdocs.yml

Lines changed: 77 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,17 @@ theme:
3535
# Enable the copy button on code blocks
3636
- content.code.copy
3737

38+
# Enables code selection button to link a specific section of a code block
39+
- content.code.select
40+
3841
# Enable annotations in code blocks
3942
- content.code.annotate
4043

4144
# Enable "view source" and "edit this page" buttons
4245
- content.action.edit
4346
# - content.action.view
47+
48+
# Enable tooltips (pop-open dialog boxes)
4449
- content.tooltips
4550

4651
# Enable Navigation buttons in the footer (i.e. previous/next)
@@ -55,9 +60,9 @@ theme:
5560

5661
# Keeps tabs visible in the header when scrolling
5762
- navigation.tabs.sticky
58-
63+
5964
# 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
6166
- navigation.top
6267

6368
# Renders path for page navigation at the top of the page (makes page navigation more mobile friendly)
@@ -125,6 +130,7 @@ theme:
125130
# Add custom admonitions
126131
github: simple/github
127132
arduino: simple/arduino
133+
rpi: simple/raspberrypi
128134
python: simple/python
129135
code: fontawesome/regular/file-code
130136
terminal: octicons/terminal-16
@@ -160,47 +166,60 @@ plugins:
160166
# Provide domains for assets that are retrieved from external sites
161167
assets_include:
162168
- https://docs.sparkfun.com/*
163-
169+
164170
# External links open in a new tab
165171
links_attr_map:
166172
target: _blank
167173
links_noopener: true
168174

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]
201218

202219
# Enables use of Git submodules and larger code base
203-
# - monorepo
220+
- monorepo:
221+
# Disables plugin on local builds
222+
enabled: !ENV [CI, false]
204223

205224

206225
# Included Markdown extensions
@@ -221,10 +240,10 @@ markdown_extensions:
221240
url_request_headers: {}
222241
dedent_subsections: True
223242

224-
# Adds support for glossary of abbreviations
243+
# Adds support for a glossary of abbreviations
225244
auto_append:
226-
- glossary-sparkfun.md
227245
# - https://raw.githubusercontent.com/santaimpersonator/git-test/main/glossary-sparkfun.md
246+
- glossary-sparkfun.md
228247
- glossary-local.md
229248

230249
# Allows embedding of code blocks in other elements
@@ -283,7 +302,7 @@ markdown_extensions:
283302
# Allows the use of abbreviations
284303
- abbr
285304

286-
# Allows the use of bundled and custom icons/emojis
305+
# Allows the use of bundled and custom icons and emojis
287306
- pymdownx.emoji:
288307
emoji_index: !!python/name:material.extensions.emoji.twemoji
289308
emoji_generator: !!python/name:material.extensions.emoji.to_svg
@@ -294,7 +313,7 @@ markdown_extensions:
294313
# Allows for the rendering of block and inline-block equations
295314
- pymdownx.arithmatex:
296315
generic: true
297-
316+
298317
# Adds permalink icon to headers
299318
- toc:
300319
permalink: ''
@@ -320,12 +339,28 @@ extra:
320339
link: https://www.facebook.com/SparkFun
321340
- icon: fontawesome/brands/x-twitter
322341
link: https://twitter.com/sparkfun
342+
- icon: fontawesome/solid/cookie-bite
343+
link: /#__consent
344+
name: Change cookie settings
323345

324-
# Google Analytics
346+
# Configures Google Analytics
325347
analytics:
326348
provider: google
327349
property: G-7Y7EYCZVC1
328350

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+
329364

330365
# Configures styling for the webpage
331366
extra_css:
@@ -350,6 +385,7 @@ exclude_docs: |
350385
not_in_nav: |
351386
index.md
352387
print_view.md
388+
favicon.ico
353389
354390
# Webpage navigation tabs
355391
nav:

0 commit comments

Comments
 (0)