-
Notifications
You must be signed in to change notification settings - Fork 10
/
mkdocs_slim.yml
266 lines (256 loc) · 12 KB
/
mkdocs_slim.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
site_name: DHIS2 Documentation
site_description: Official documentation of the DHIS2 platform
site_author: DHIS2 Documentation Team
# site_url sets the canonical url - we want this to point to the latest version
site_url: 'https://docs.dhis2.org/en/'
copyright: 'Copyright © 2008-2024 DHIS2 Team'
# edit_uri: ''
repo_url: https://github.com/dhis2/dhis2-docs
repo_name: 'dhis2-docs on GitHub'
use_directory_urls: false
# docs_dir:
extra:
dhis2_languages:
en: 'English'
fr: 'Français'
es_419: 'Español (latinoamerica)'
pt: 'Português'
cs: 'čeština'
zh: '中文'
ar: 'العربية'
social:
- icon: fontawesome/brands/github
link: https://www.github.com/dhis2
name: DHIS2 source code on GitHub
- icon: fontawesome/brands/docker
link: https://hub.docker.com/u/dhis2
name: DHIS2 on Docker
- icon: fontawesome/brands/twitter
link: https://twitter.com/dhis_2
name: DHIS2 on Twitter
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/dhis2
name: DHIS2 on Facebook
- icon: fontawesome/brands/discourse
link: https://community.dhis2.org
name: DHIS2 Community
analytics:
provider: google
property: G-N3FZVSJ4Z4
validation:
omitted_files: ignore
absolute_links: ignore
unrecognized_links: ignore
theme:
name: material
logo: 'resources/images/logo.svg'
favicon: 'resources/images/favicon.ico'
features:
- navigation.menutabs
- navigation.tabs.sticky
- navigation.top
- navigation.instant
- navigation.indexes
- toc.integration
- content.action.edit
- content.code.copy
- search.suggest
- search.highlight
- search.share
alternates:
alt_marker: 'alt__'
custom_dir: 'theme'
palette:
- scheme: default
primary: 'black'
accent: 'blue'
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: 'black'
toggle:
icon: material/weather-sunny
name: Switch to light mode
language: 'en'
font: false
filter:
versions:
- 'master'
- '2.41'
- '2.40'
- '2.39'
categories:
- Use
- Implement
- Develop
- Manage
- Metadata
- Tutorials
- Stories
- Training
filter_boost:
- '2.41'
# our css
extra_css:
- resources/css/mkdocs_dhis2.css
extra_javascript:
- https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
- resources/javascript/config.js
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- resources/javascript/init_kapa_widget.js
plugins:
- search:
separator: '[\s]+'
- mkdocs_video:
css_style:
position: "relative"
width: "600px"
height: "400px"
- edit_url
- dhis2_docs
- minify:
minify_html: true
- offline
markdown_extensions:
- codehilite:
guess_lang: false
- markdown_captions
- toc:
permalink: true
toc_depth: 3
- d_cardbox
- d_card
- attr_list
- def_list
- footnotes
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.emoji:
emoji_index: !!python/name:pymdownx.emoji.gemoji
emoji_generator: !!python/name:pymdownx.emoji.to_png
- pymdownx.inlinehilite:
custom_inline:
- name: math
class: arithmatex
format: !!python/name:pymdownx.arithmatex.inline_mathjax_format
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols:
copyright: false
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tilde
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
# output when building
site_dir: ./target/en/
nav:
- Home: '@github(dhis2/dhis2-docs, src/home.md, master)'
- Terms of use: '@github(dhis2/dhis2-docs, src/termsofuse.md, master)'
- Implement:
Implement: '@github(dhis2/dhis2-docs-implementation, content/index.md, master)'
Support and documentation:
- DHIS2 Documentation Guide: '@github(dhis2/dhis2-docs-implementation, content/support_documentation/dhis2-documentation-guide.md, master)'
- Submitting quick document fixes: '@github(dhis2/dhis2-docs, src/common/submitting-a-doc-fix.md, master)'
- Using JIRA for DHIS2 issues: '@github(dhis2/dhis2-docs-implementation, content/support_documentation/using-jira-for-dhis2-issues.md, master)'
- Support: '@github(dhis2/dhis2-docs-implementation, content/support_documentation/support.md, master)'
Software Release Information:
DHIS2 core releases:
alt__DHIS core version 2.36:
- Release Notes: '@github(dhis2/dhis2-releases,releases/2.36/ReleaseNote-2.36.md, master)'
- Upgrade Notes: '@github(dhis2/dhis2-releases,releases/2.36/README.md, master)'
alt__DHIS core version 2.35:
- Release Notes: '@github(dhis2/dhis2-releases,releases/2.35/ReleaseNote-2.35.0.md, master)'
- Upgrade Notes: '@github(dhis2/dhis2-releases,releases/2.35/README.md, master)'
alt__DHIS core version 2.34:
- Release Notes: '@github(dhis2/dhis2-releases,releases/2.34/ReleaseNote-2.34.0.md, master)'
- Upgrade Notes: '@github(dhis2/dhis2-releases,releases/2.34/README.md, master)'
Android app releases:
alt__DHIS core version 2.36:
alt__Android app version 2.4.0:
- Release Notes: '@github(dhis2/dhis2-releases,android-releases/2.4/ReleaseNote-2.4.0.md, master)'
alt__DHIS core version 2.35:
alt__Android app version 2.3.0:
- Release Notes: '@github(dhis2/dhis2-releases,android-releases/2.3/ReleaseNote-2.3.0.md, master)'
alt__DHIS core version 2.34:
alt__Android app version 2.2.0:
- Release Notes: '@github(dhis2/dhis2-releases,android-releases/2.2/ReleaseNote-2.2.0.md, master)'
alt__Android app version 2.1.0:
- Release Notes: '@github(dhis2/dhis2-releases,android-releases/2.1/ReleaseNote-2.1.0.md, master)'
- Develop:
Develop: '@github(dhis2/dhis2-docs, src/developer/index.md, master)'
Using the API:
alt__DHIS core version 2.39:
- Introduction: '@github(dhis2/dhis2-docs, src/developer/web-api/overview.md, 2.39)'
- Metadata: '@github(dhis2/dhis2-docs, src/developer/web-api/metadata.md, 2.39)'
- Metadata Gist: '@github(dhis2/dhis2-docs, src/developer/web-api/metadata-gist.md, 2.39)'
- Data: '@github(dhis2/dhis2-docs, src/developer/web-api/data.md, 2.39)'
- Manage:
Manage: '@github(dhis2/dhis2-docs, src/sysadmin/index.md, master)'
Performing system administration:
alt__DHIS core version 2.36:
- Installation: '@github(dhis2/dhis2-docs, src/sysadmin/installation.md,2.36)'
- Upgrading: '@github(dhis2/dhis2-docs, src/sysadmin/upgrading.md, master)'
- Monitoring: '@github(dhis2/dhis2-docs, src/sysadmin/monitoring.md,2.36)'
- Audit: '@github(dhis2/dhis2-docs, src/sysadmin/audit.md,2.36)'
- Using Gateways for SMS reporting: '@github(dhis2/dhis2-docs, src/sysadmin/SMS-reporting.md,2.36)'
alt__DHIS core version 2.35:
- Installation: '@github(dhis2/dhis2-docs, src/sysadmin/installation.md,2.35)'
- Upgrading: '@github(dhis2/dhis2-docs, src/sysadmin/upgrading.md, master)'
- Monitoring: '@github(dhis2/dhis2-docs, src/sysadmin/monitoring.md,2.35)'
- Audit: '@github(dhis2/dhis2-docs, src/sysadmin/audit.md,2.35)'
- Using Gateways for SMS reporting: '@github(dhis2/dhis2-docs, src/sysadmin/SMS-reporting.md,2.35)'
alt__DHIS core version 2.34:
- Installation: '@github(dhis2/dhis2-docs, src/sysadmin/installation.md,2.34)'
- Upgrading: '@github(dhis2/dhis2-docs, src/sysadmin/upgrading.md, master)'
- Monitoring: '@github(dhis2/dhis2-docs, src/sysadmin/monitoring.md,2.34)'
- Audit: '@github(dhis2/dhis2-docs, src/sysadmin/audit.md,2.34)'
- Using Gateways for SMS reporting: '@github(dhis2/dhis2-docs, src/sysadmin/SMS-reporting.md,2.34)'
alt__DHIS core version master:
- Installation: '@github(dhis2/dhis2-docs, src/sysadmin/installation.md, master)'
- Upgrading: '@github(dhis2/dhis2-docs, src/sysadmin/upgrading.md, master)'
- Monitoring: '@github(dhis2/dhis2-docs, src/sysadmin/monitoring.md, master)'
- Audit: '@github(dhis2/dhis2-docs, src/sysadmin/audit.md, master)'
- Using Gateways for SMS reporting: '@github(dhis2/dhis2-docs, src/sysadmin/SMS-reporting.md, master)'
- Topics:
- alt__Tutorials:
- Tutorials: '@github(dhis2/dhis2-docs, src/tutorials/index.md, master)'
- '@github(dhis2/cache-cleaner-app, docs/tutorials/index.yml, master)'
- Configure OIDC with Okta: '@github(dhis2/dhis2-docs, src/tutorials/configure-oidc-with-okta.md, master)'
- Setting up targets: '@github(dhis2/dhis2-docs, src/tutorials/setting-up-targets.md, master)'
- Creating scorecards with Pivot Tables: '@github(dhis2/dhis2-docs, src/tutorials/creating-scorecards-using-pt-app.md, master)'
- Setting up email: '@github(dhis2/dhis2-docs, src/tutorials/setting-up-email.md, master)'
- Google Earth Engine sign-up: '@github(dhis2/dhis2-docs, src/tutorials/google-earth-engine-signup.md, master)'
- Analysing Nginx logs using goAccess: '@github(dhis2/dhis2-docs, src/tutorials/analysing-nginx-logs-using-goaccess.md, master)'
- Analysing Postgresql logs using pgbadger: '@github(dhis2/dhis2-docs, src/tutorials/analysing-postgresql-logs-using-pgbadger.md, master)'
- What are users up to?: '@github(dhis2/dhis2-docs, src/tutorials/what-are-users-up-to.md, master)'
- alt__User Stories:
- User Stories: '@github(dhis2/dhis2-docs, src/stories/index.md, master)'
- Improving surveillance of Visceral Leishmaniasis VL in Somalia: '@github(dhis2/dhis2-docs, src/stories/dhis2-tracker-improving-surveillance-of-visceral-leishmaniasis-vl-in-somalia-draft.md, master)'
- DHIS2 in the Autonomous Region of Kurdistan, Iraq: '@github(dhis2/dhis2-docs, src/stories/dhis2-in-the-autonomous-region-of-kurdistan-iraq.md, master)'
- West Africa Regional Systems and DHIS2: '@github(dhis2/dhis2-docs, src/stories/west-africa-regional-systems-and-dhis2.md, master)'
- Zambia Education Management System EMIS: '@github(dhis2/dhis2-docs, src/stories/zambia-education-management-system-emis.md, master)'
- Rwanda HMIS powered by DHIS2: '@github(dhis2/dhis2-docs, src/stories/rwanda-hmis-powered-by-dhis2.md, master)'
- DHIS2 Tracker e-Registry in Palestine: '@github(dhis2/dhis2-docs, src/stories/dhis2-tracker-e-registry-in-palestine.md, master)'
- Tanzania Integrated Health Information Architecture:
- Overview: '@github(dhis2/dhis2-docs, src/stories/tanzania-integrated-health-information-architecture.md, master)'
- Architecture: '@github(dhis2/dhis2-docs, src/stories/tanzania-integrated-health-information-architecture_B.md, master)'
- DHIS2 - a Management Information System at PSI: '@github(dhis2/dhis2-docs, src/stories/dhis2-a-management-information-system-at-psi.md, master)'
- Zambia WASH Mobile surveillance using DHIS2: '@github(dhis2/dhis2-docs, src/stories/zambia-wash-mobile-surveillance-using-dhis2.md, master)'
- alt__Complete Manuals:
- User Manuals: '@file(special_pages/single_page_user.md)'
- Optional Apps Manuals: '@file(special_pages/single_page_optional.md)'
- Developer Manuals: '@file(special_pages/single_page_developer.md)'
- Implementer Guides: '@file(special_pages/single_page_implementer.md)'
- Administrator Guides: '@file(special_pages/single_page_admin.md)'