forked from LoopKit/loopdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
189 lines (181 loc) · 7.21 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
# 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 light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
toggle:
icon: material/brightness-4
name: Switch to light mode
# repo_url: https://github.com/LoopKit/Loop
extra_css:
- stylesheets/extra.css
- stylesheets/primary-color.css
markdown_extensions:
- meta
- abbr
- admonition
- attr_list
- pymdownx.arithmatex:
generic: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- 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
use_directory_urls: !ENV [CHECK_BROKEN_LINKS, True]
nav:
- Home: 'index.md'
- Intro:
- 'LoopDocs Overview': 'intro/overview-intro.md'
- 'LoopDocs How-to': 'intro/loopdocs-how-to.md'
- 'Requirements': 'intro/requirements.md'
- 'Compatible iPhone/iPod': 'build/step2.md'
- 'Compatible Pump': 'build/step3.md'
- 'Compatible CGM': 'build/step4.md'
- 'RileyLink': 'build/step5.md'
- 'Apple Developer Program': 'build/step6.md'
- 'Test Settings': 'build/step10.md'
- 'Loop Data': 'build/step11.md'
- 'Meet the Community': 'build/step12.md'
- Browser Build:
- 'GitHub Build Overview': gh-actions/gh-overview.md
- 'GitHub First-Time': gh-actions/gh-first-time.md
- 'GitHub Deploy': gh-actions/gh-deploy.md
- 'GitHub Update': gh-actions/gh-update.md
- 'GitHub Errors': gh-actions/gh-errors.md
- 'Other Apps': gh-actions/gh-other-apps.md
- Mac-Xcode Build:
- 'Mac-Xcode Build Overview': 'build/overview.md'
- 'Compatible Computer': 'build/step1.md'
- 'Download Xcode': 'build/step8.md'
- 'Xcode Preferences': 'build/step9.md'
- 'Build Loop': 'build/step14.md'
- 'Oh dear! Build errors?': 'build/build_errors.md'
- 'Updating/Rebuilding': 'build/updating.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/workout.md'
- 'Apple Watch': 'operation/features/watch.md'
- 'Loop Notifications': 'operation/features/notifications.md'
- 'Pre-Meal Target': 'operation/features/premeal.md'
- 'Using ICE Info': '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/yellow-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'
- 'Loop Releases': 'version/releases.md'
- 'Customize Your Loop': 'build/code_customization.md'
- 'Customize with GitHub': 'gh-actions/gh-customize.md'
- 'Simulator Build': 'version/simulator.md'
- 'Loop Development': 'version/development.md'
- 'Build Loop 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/troublehoot.md'
- 'Remote Commands': 'nightscout/remote-overrides.md'
- 'Nightscout Cross Ref': 'nightscout/ns_crossref.md'
- FAQs:
- 'FAQs Overview': 'faqs/overview-faqs.md'
- 'Safety Tips': 'faqs/safety-faqs.md'
- 'Loop FAQs': 'faqs/FAQs.md'
- 'Time Change FAQs': 'troubleshooting/time-change.md'
- 'Omnipod FAQs': 'faqs/omnipod-faqs.md'
- 'CGM FAQs': 'faqs/cgm-faqs.md'
- 'Update/Rebuild Loop FAQs': 'faqs/update-faqs.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'