forked from LoopKit/loopdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
250 lines (239 loc) · 10.1 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: LoopDocs
theme:
name: material
language: en
features:
- navigation.footer
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- navigation.top
- search.suggest
- search.highlight
- content.code.annotate
- content.tooltips
logo: loop-logo.png
favicon: loop-logo.png
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
toggle:
icon: material/weather-night
name: Switch to auto (use System Preferences)
# repo_url: https://github.com/LoopKit/Loop
extra_css:
- stylesheets/primary-color.css
- stylesheets/extra.css
markdown_extensions:
- meta
- abbr
- admonition
- attr_list
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
- pymdownx.mark
- pymdownx.tilde
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.superfences:
# make exceptions to highlighting of code:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets:
auto_append:
- includes/tooltip-list.txt
- toc:
permalink: true
permalink_title: Anchor link to this Header on this Page
toc_depth: 3
title: Headers on this Page
extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- search
- htmlproofer:
enabled: !ENV [CHECK_BROKEN_LINKS, False]
raise_error_after_finish: true
- redirects:
redirect_maps:
'build/build_errors.md': 'build/build-errors.md'
'build/code_customization.md': 'version/code-custom-edits.md'
'build/code-customization.md': 'version/code-custom-edits.md'
'build/step1.md': 'build/computer.md'
'build/step10.md': 'build/test-settings.md'
'build/step11.md': 'build/loop-data.md'
'build/step12.md': 'build/community.md'
'build/step14.md': 'build/build-app.md'
'build/step2.md': 'build/phone.md'
'build/step3.md': 'build/pump.md'
'build/step4.md': 'build/cgm.md'
'build/step5.md': 'build/rileylink.md'
'build/step6.md': 'build/apple-developer.md'
'build/step8.md': 'build/xcode-version.md'
'build/step9.md': 'build/xcode-settings.md'
'gh-actions/gh-customize.md': 'gh-actions/edit-browser.md'
'faqs/FAQS.md': 'faqs/loop-faqs.md'
'loop-3/displays_v3.md': 'loop-3/displays-v3.md'
'nightscout/new_user.md': 'nightscout/new-user.md'
'nightscout/ns_crossref.md': 'nightscout/ns-crossref.md'
'nightscout/remote-overrides.md': 'nightscout/remote-overview.md'
'nightscout/troublehoot.md': 'nightscout/troubleshoot.md'
'nightscout/update_user.md': 'nightscout/update-user.md'
'operation/features/workout.md': 'operation/features/overrides.md'
'operation/loop-settings/services_v2.md': 'operation/loop-settings/services-v2.md'
'troubleshooting/time-change.md': 'faqs/time-faqs.md'
'troubleshooting/yellow-red-loop.md': 'troubleshooting/red-loop.md'
- unused_files:
enabled: !ENV [CHECK_UNUSED_FILES, False]
excluded_files:
- .DS_Store
- loop-logo.png
- extra.css
- primary-color.css
use_directory_urls: !ENV [CHECK_BROKEN_LINKS, True]
validation:
anchors: warn
nav:
- Home: 'index.md'
- Intro:
- 'LoopDocs Overview': 'intro/overview-intro.md'
- 'LoopDocs How-to': 'intro/loopdocs-how-to.md'
- 'Requirements Overview': 'intro/requirements.md'
- 'Compatible iPhone': 'build/phone.md'
- 'Compatible Pump': 'build/pump.md'
- 'Compatible CGM': 'build/cgm.md'
- 'RileyLink': 'build/rileylink.md'
- 'Apple Developer Program': 'build/apple-developer.md'
- 'Test Settings': 'build/test-settings.md'
- 'Loop Data': 'build/loop-data.md'
- 'Meet the Community': 'build/community.md'
- Build with Browser:
- 'Browser Overview': gh-actions/gh-overview.md
- 'Configure to use Browser': gh-actions/gh-first-time.md
- 'Errors with Browser': gh-actions/gh-errors.md
- 'Install on Phone': gh-actions/gh-deploy.md
- 'Update/Rebuild with Browser': gh-actions/gh-update.md
- 'Automatic Update & Build': gh-actions/automatic.md
- 'Customize using Browser': 'gh-actions/custom-browser.md'
- 'Custom Edits with Browser': 'gh-actions/edit-browser.md'
- 'Build Loop dev with Browser': gh-actions/build-dev-browser.md
- 'Build Other Apps with Browser': gh-actions/gh-other-apps.md
- Build with Mac:
- 'Mac Overview': 'build/overview.md'
- 'Compatible Computer': 'build/computer.md'
- 'Xcode Version': 'build/xcode-version.md'
- 'Xcode Settings': 'build/xcode-settings.md'
- 'Build Loop': 'build/build-app.md'
- 'Oh dear! Build errors?': 'build/build-errors.md'
- 'Update/Rebuild with Mac': 'build/updating.md'
- 'Customize using Mac': 'build/custom-mac.md'
- 'Custom Edits with Mac': 'build/edit-mac.md'
- 'Build Loop dev with Mac': 'build/build-dev-mac.md'
- 'Build Free Loop': 'build/build-free-loop.md'
- 'TestFlight from Xcode': 'build/testflight-xcode.md'
- Set Up:
- 'Overview': 'loop-3/loop-3-overview.md'
- 'Onboarding': 'loop-3/onboarding.md'
- 'Add CGM': 'loop-3/add-cgm.md'
- 'Add Pump': 'loop-3/add-pump.md'
- 'Settings': loop-3/settings.md
- 'Therapy Settings': 'loop-3/therapy-settings.md'
- 'Optional: Services': 'loop-3/services.md'
- 'Displays': 'loop-3/displays-v3.md'
- 'RileyLink Display': 'operation/loop-settings/rileylink.md'
- 'Omnipod Pump': loop-3/omnipod.md
- 'Medtronic Pump': loop-3/medtronic.md
- 'Features': 'loop-3/features.md'
- 'Loop 2: Set Up App':
- 'Loop 2 Overview': 'operation/overview.md'
- 'Loop 2 Health Permissions': 'build/health.md'
- 'Loop 2 Add Pump':
- 'Loop 2 Add Medtronic': 'operation/loop-settings/mdt-pump.md'
- 'Loop 2 Add Omnipod': 'operation/loop-settings/omnipod-pump.md'
- 'Loop 2 Add CGM': 'operation/loop-settings/cgm.md'
- 'Loop 2 Configuration': 'operation/loop-settings/configurations.md'
- 'Loop 2 Services': 'operation/loop-settings/services-v2.md'
- 'Loop 2 Displays': 'operation/loop-settings/displays.md'
- 'Loop 2 Pump Settings': 'operation/loop-settings/pump-commands.md'
- Operate:
- 'Open Loop': 'operation/loop/open-loop.md'
- 'Closed Loop': 'operation/loop/close-loop.md'
- 'Meal Entries': 'operation/features/carbs.md'
- 'Bolus': 'operation/features/bolus.md'
- 'Overrides': 'operation/features/overrides.md'
- 'Apple Watch': 'operation/features/watch.md'
- 'Loop Notifications': 'operation/features/notifications.md'
- 'Pre-Meal Target': 'operation/features/premeal.md'
- 'Meal Review': 'operation/features/ice.md'
- 'iPhone Widget': 'operation/features/widget.md'
- Loop Tips: 'operation/loop/looptips.md'
- Algorithm:
- 'Algorithm Overview': 'operation/algorithm/overview.md'
- 'Bolus Recommendations': 'operation/algorithm/bolus.md'
- 'Glucose Prediction': 'operation/algorithm/prediction.md'
- 'Automated Adjustments': 'operation/algorithm/temp-basal.md'
- Troubleshoot:
- 'Troubleshooting Overview': 'troubleshooting/overview.md'
- 'Loop App Crashes': 'troubleshooting/loop-crashing.md'
- 'Red Loop': 'troubleshooting/red-loop.md'
- 'Pod Pairing Failures': 'troubleshooting/pod-pairing.md'
- 'Omnipod Faults': 'troubleshooting/omnipod-faults.md'
- 'MDT Pump Errors': 'troubleshooting/pump-errors.md'
- 'MDT Pump Battery': 'operation/features/battery.md'
- 'Version':
- 'Version Overview': 'version/overview-version.md'
- 'Releases': 'version/releases.md'
- 'Custom Edits': 'version/code-custom-edits.md'
- 'Build-Time Flag': 'version/build-time-flag.md'
- 'Simulator Build': 'version/simulator.md'
- 'Loop Development': 'version/development.md'
- 'Build Dev': 'version/build-dev.md'
- 'LoopWorkspace': 'version/loopworkspace.md'
- Nightscout:
- 'Nightscout Overview': 'nightscout/overview.md'
- 'New Nightscout': 'nightscout/new-user.md'
- 'Nightscout with Loop': 'nightscout/update-user.md'
- 'Nightscout Troubleshooting': 'nightscout/troubleshoot.md'
- 'Nightscout Cross Ref': 'nightscout/ns-crossref.md'
- 'Remote Overview': 'nightscout/remote-overview.md'
- 'Remote Configuration': 'nightscout/remote-config.md'
- 'Remote Commands': 'nightscout/remote-commands.md'
- 'Remote Errors': 'nightscout/remote-errors.md'
- '<span translate="no">Loop Caregiver<span>': 'nightscout/loop-caregiver.md'
- FAQs:
- 'FAQs Overview': 'faqs/overview-faqs.md'
- 'Safety Tips': 'faqs/safety-faqs.md'
- 'Loop FAQs': 'faqs/loop-faqs.md'
- 'Time FAQs': 'faqs/time-faqs.md'
- 'Omnipod FAQs': 'faqs/omnipod-faqs.md'
- 'CGM FAQs': 'faqs/cgm-faqs.md'
- 'Update/Rebuild Loop FAQs': 'faqs/update-faqs.md'
- 'New Phone Tips': 'faqs/new-phone.md'
- 'RileyLink FAQs': 'faqs/rileylink-faqs.md'
- 'Algorithm FAQs': 'faqs/algorithm-faqs.md'
- 'Apple Health FAQs': 'faqs/apple-health-faqs.md'
- 'Glossary': 'faqs/glossary.md'
- Translation: 'translate.md'