-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
289 lines (253 loc) · 9.54 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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# Documentation page information
site_name: Leeman Geophysical Knowledge Base
site_description: Documentation for Leeman Geophysical products.
site_url: https://docs.leemangeophysical.com/knowledgebase
site_author: Leeman Geophysical LLC
repo_url: https://github.com/LeemanGeophysicalLLC/knowledgebase
repo_name: LeemanGeophysicalLLC/knowledgebase
copyright:
Copyright 2024 - <a href="https://www.leemangeophysical.com/" target="_blank" rel="noopener">Leeman Geophysical LLC®<br>
23830 West Highway 12, Gentry, AR 72734
# Default edit/view actions to "main" branch, instead of "master"
edit_uri: blob/main/docs/
# Configuration for webpage theme
theme:
# Theme: https://squidfunk.github.io/mkdocs-material/
name: material
# Icon in Browser Tab (must be square img - i.e. 32x32 pixels)
favicon: assets/lgeo_favicon_32x32.png
# Page Font
font:
text: Roboto
code: Roboto Mono
# Features to Include (ref. theme documentation)
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://url.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 the webpage
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: brown
accent: blue grey
toggle:
icon: material/brightness-auto
name: Switch to dark mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
primary: brown
accent: blue grey
scheme: default
toggle:
icon: material/brightness-7
name: Switch to system preference
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
primary: brown
accent: blue grey
scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
# Configures icons
icon:
# Sets homepage icon
logo: lgeo_logo
# 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 (callout boxes)
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
hot: material/fire-alert
# Permalink icon
link: octicons/link-16
# Adds overrides for stylesheets, html, etc.
custom_dir: overrides
# Included MkDocs plugins
# Add the installation of any new plugins to the ./github/workflows/mkdocs.yml file also
plugins:
- search
#- typeset
#- redirects:
# redirect_maps:
# 'index.md': 'introduction.md'
# Add revision date
#- git-revision-date-localized:
# enable_creation_date: true
# type: timeago
# Add git committers at bottom of the page
#- git-committers:
# repository: sparkfun/SparkFun_Qwiic_Buzzer
# branch: main
# Add git authors at bottom of the page
#- git-authors
# Enables use of Git submodules and larger code base
#- monorepo
# For PDF rendering
# - with-pdf:
# author: SparkFun Electronics®
# copyright: Copyright 2023 - SparkFun Electronics®
# cover_subtitle: none
# cover_logo: img/sfe_logo_sm.png
# exclude_pages: [ "hard_copy", "single_page", "file_issue", "contribute" ]
# render_js: true
# headless_chrome_path: headless-chromium
# output_path: board_files/hookup_guide.pdf
markdown_extensions:
- pymdownx.arithmatex:
generic: true
- attr_list
#- pymdownx.emoji:
# emoji_index: !!python/name:materialx.emoji.twemoji
# emoji_generator: !!python/name:materialx.emoji.to_svg
# options:
# custom_icons:
# - overrides/.icon
# 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
#- pymdownx.arithmatex:
# generic: true
#- toc:
# permalink: ''
# Link: 🔗 🔗
# Chain: ⛓ ⛓
extra:
# Configures the hyperlink for the logo in the header
homepage: https://www.leemangeophysical.com/
# Configures social icons in the footer
social:
- icon: lgeo_logo
link: https://www.leemangeophysial.com/
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/channel/UCxf3A7ipm0YjF56LrI5eCnQ
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/leemangeophysical
- icon: fontawesome/brands/github
link: https://www.github.com/leemangeophysicalllc
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/leemangeophysical
- icon: fontawesome/brands/twitter
link: https://twitter.com/leemangeophys
# Configures styling for PDF rendering and webpage layout
#extra_css:
# - stylesheet/extra.css
# Enables support for rendering block and inline block equations through MathJax
extra_javascript:
# # Enables support for rendering block and inline block equations through MathJax
- javascript/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# Configures webpage navigation
nav:
- Products:
- Sensors and Sensing:
- 4 Channel RTD Interface: 'RTD_Interface/rtd_interface.md'
- Tilt/Inclination:
- Precision MEMS Inclinometer: 'Precision_MEMS_Inclinometer/precision_mems_inclinometer.md'
- Tilt Meter Logger: 'Tilt_Meter_Logger/tilt_meter_logger.md'
- PTM102: 'PTM102/PTM102.md'
- Calibration:
- Displacement Transducer Calibration System: 'Displacement_Transducer_Calibration_System/displacement_transducer_calibration_system.md'
- SMPL:
- Introduction: 'SMPL/smpl.md'
- Standard: 'SMPL/smpl_standard.md'
- Accessories: 'SMPL/accessories.md'
- DCDT Signal Conditioner: 'SMPL/dcdt_signal_conditioner/dcdt_signal_conditioner.md'
- Load Cell Signal Conditioner: 'SMPL/load_cell_signal_conditioner/load_cell_signal_conditioner.md'
- DB9 Breakouts: 'SMPL/db9_breakouts/db9_breakouts.md'
- Power Bus: 'SMPL/smpl_power_bus/smpl_power_bus.md'
- Compact 4 Pin Breakout: 'SMPL/smpl_compact_4pin_breakout/smpl_compact_4pin_breakout.md'
- Labjack T8 Analog Input PCB: 'SMPL/smpl_labjack_t8_analog_input_pcb/smpl_labjack_t8_analog_input_pcb.md'
- Type K Thermocouple Amplifier: 'SMPL/smpl_type_k_thermocouple_amplifier/smpl_type_k_thermocouple_amplifier.md'
- DB9 Protoboard Breakout: 'SMPL/DB9_protoboard_breakout/DB9_protoboard_breakout.md'
- BNC Breakout: 'SMPL/smpl_bnc_breakout/smpl_bnc_breakout.md'
- DriveCommand:
- DAC: 'DriveCommand/DriveCommandDAC/drivecommanddac.md'
- FieldVolt:
- Standard: 'FieldVolt/fieldvolt_standard.md'
- Cables: 'FieldVolt/fieldvolt_cables.md'
- Solar Panels: 'FieldVolt/fieldvolt_solar_panels.md'
- Accessories: 'FieldVolt/fieldvolt_accessories.md'
- Power Case: 'FieldVolt/FieldVolt_Power_Case/fieldvolt_power_case.md'
- Orange EDU:
- Contour Map Lab: 'Contour_Map_Lab/contour_map_lab.md'
- Creep Deformation Apparatus: 'Creep_Deformation_Apparatus/creep_deformation_apparatus.md'
- Geologist's Squeeze Box: 'Geologists_Squeeze_Box/geologist_squeeze_box.md'
- Spring Slider Earthquake Machine: 'Spring_Slider_Earthquake_Machine/spring_slider_earthquake_machine.md'
- Waveform Blinky Kit: 'Waveform_Blinky/waveform_blinky.md'
- Other:
- Instrument Orientation Tool: 'Instrument_Orientation_Tool/instrument_orientation_tool.md'
- Application Notes: appnotes.md
- Downloads: downloads.md
- Resources: resources.md
- Support: support.md