generated from jobindjohn/obsidian-publish-mkdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs-terminal.yml
378 lines (344 loc) · 12.7 KB
/
mkdocs-terminal.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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
site_name: Cockpitdecks Documentation
site_url: https://devleaks.github.io/cockpitdecks-docs/
repo_url: https://github.com/devleaks/cockpitdecks
site_description: Documentation for Cockpitdecks X-Plane Application and Plugin
copyright: |
Copyright © 2023 - 2024 <a href="https://github.com/devleaks" target="_blank" rel="noopener">Pierre M</a>
# ###############################################
#
# Theme and appearance
#
theme:
name: terminal # material # Must use Material theme
# custom_dir: docs/.theme # If you have overrides, specify where to find them
logo: assets/images/favicon.png
# favicon: assets/images/favicon.png
icon:
logo: assets/images/favicon.png
# palette:
# scheme: dracula # This is how to enables the Dracula theme for dark. For light, it will use default Material with some tweaks.
# primary: deep purple # Primary colors
# accent: orange # accent color
font:
text: Roboto
code: Fira Mono
features:
- announce.dismiss
- navigation.tabs
- navigation.top
- navigation.instant
- navigation.indexes
- toc.follow
- content.tabs.link
- search.share
- search.highlight
- search.suggest
- content.code.copy
- content.code.annotations
# Uncomment to add move and credit to mkdocs material designers
# pymdownx:
# sponsor: "https://github.com/sponsors/facelessuser"
#
#
#
# Dracula is a dark theme only. Dracula can't stand the light.
#
#
# ###############################################
#
# Navigation, headings, «tabs»
#
# ===============================================
#
# T A B L E O F C O N T E N T
#
nav:
- Welcome: index.md
- Cockpitdecks:
- Concepts: Concepts.md
- Cockpit: Cockpit.md
- Deck: Deck.md
- Layout: Layout.md
- Page: Page.md
- Button: Button.md
- Resources:
- Resources: Resources.md
- Themes: Resources/Themes.md
- Observables: Resources/Observables.md
- Simulator: Simulator.md
- Buttons:
- Button Index: Button/Button Index.md
- Button Attributes: Button/Button Attribute Default Values.md
- Button Value: Button/Button Value.md
- Button Activation: Button/Button Activation.md
- Button Representation:
- Button Representation: Button/Button Representation.md
- Basic Buttons: Button/Button Representations/Basic.md
- Drawn Buttons: Button/Button Representations/Drawn Buttons.md
- Annunciators: Button/Button Representations/Annunciator.md
- Switches: Button/Button Representations/Drawn Buttons – Switches.md
- Data Buttons Charts, Indicators, Gauges: Button/Button Representations/Drawn Buttons – Charts.md
- Advanced Representations:
- Mosaic (Large LCD Touchscreen): Button/Button Representations/Multi-Buttons and Mosaic.md
- Deck Specific Representations – Stream Deck: Button/Button Representations/Deck Specific – Stream Deck.md
- Deck Specific Representations – Loupedeck: Button/Button Representations/Deck Specific – Loupedeck.md
- Deck Specific Representations – X-Touch Mini: Button/Button Representations/Deck Specific – X-Touch Mini.md
- Aircraft Specific Representations – Toliss Airbus: Button/Button Representations/Toliss Specific Representations.md
- Weather Representations: Button/Button Representations/Weather.md
- Animated Buttons: Button/Button Representations/Animations.md
- « Hardware » Representations: Extending/Development/Internals/Hardware Representation.md
- Data Value Change: Button/Set Dataref.md
- « Commands »: Button/The New View Attribute.md
- Running:
- Installation: Running/Installation.md
- Usage: Running/Usage.md
- Examples:
- Extending/Examples.md
- Tutorials:
- Adding a Page of Buttons to a Deck: Running/Adding a Page of Buttons to a Deck.md
- Adding a Web Deck: Extending/Adding a Web Deck.md
- Extending:
- Adding web decks: Extending/Web Decks.md
- Adding new physical deck models: Extending/Adding New Deck Models.md
- Developments:
- Extending Cockpitdecks: Extending/Extending Cockpitdecks.md
- (Python) Packaging: Extending/Development/Packaging.md
- Adding activations: Extending/Development/Adding Activations.md
- Adding representations: Extending/Development/Adding Representations.md
- Adding a simulator: Extending/Development/Adding a Simulator.md
- Activation for developers: Extending/Development/Button Activations for Developers.md
- Web Deck Designer Tools: Extending/Development/Internals/Design Helper.md
- Workflow for Web Deck Design: Extending/Development/Internals/Workflow for Web Deck Design.md
# - Application Programming Interfaces: Extending/Development/API/index.md
- Internals:
- Cockpitdecks Internals: Extending/Development/Internals/Cockpitdecks Internals.md
- Deck Internals: Extending/Development/Internals/Deck Internals.md
- Events: Extending/Development/Internals/Events.md
- Instructions: Extending/Development/Internals/Instruction.md
- Value: Extending/Development/Internals/Value.md
- Simulator Data Collection: Extending/Development/Internals/Dataref Scanning.md
- Cockpitdecks Internal Data: Extending/Development/Internals/Internal Datarefs.md
- Deck Event Processing: Extending/Development/Internals/Deck Event Processing.md
- Web Decks Internals: Extending/Development/Internals/Web Decks Internals.md
- Replay: Extending/Development/Internals/Replay.md
- X-Plane Simulator:
- X-Plane: Extending/Development/Reference/X-Plane/X-Plane.md
- X-Plane Cockpitdecks Plugin: Extending/Development/Reference/X-Plane/X-Plane Cockpitdecks Plugin.md
- X-Plane Interaction: Extending/Development/Reference/X-Plane/X-Plane Interaction.md
- String Datarefs: Extending/Development/Reference/X-Plane/String Datarefs.md
- To Do: Extending/Development/Internals/To do.md
- Reference:
- Concepts: Concepts.md
- Glossary: Extending/Development/Reference/Glossary.md
- Environment: Extending/Development/Reference/Environment.md
- Configuration Files and Attributes: Extending/Development/Internals/Configuration Files and Attributes.md
- Activation: Extending/Development/Reference/Activation.md
- Representation: Extending/Development/Reference/Representation.md
- Switch Drawing Attributes: Extending/Development/Reference/Switch Drawing Attributes.md
- Deck Type: Extending/Development/Reference/Deck Type.md
- Simulator: Extending/Development/Reference/Simulator.md
- History: History.md
#
# ===============================================
# ###############################################
#
# Plugins
#
plugins:
# - markdown-exec # this adds ```tree representation support
- search
- roamlinks
- callouts
- charts
- markmap:
base_path: docs
encoding: utf-8
file_extension: .mm.md
- git-revision-date-localized:
type: timeago
fallback_to_build_date: true
# - tags
# - mkdocstrings:
# handlers:
# python:
# # paths: ["https://raw.githubusercontent.com/devleaks/cockpitdecks/refs/heads/main/cockpitdecks"]
# paths: ["/Users/pierre/Developer/fs/cockpitdecks"]
# options:
# docstring_style: google
# show_source: false
# default_handler: python
# ###############################################
#
# Extensions
#
# Note: Some extensions have been commented out because unused.
# Restoring some extension may require added appropriate
# python package.
#
markdown_extensions:
- nl2br
- markdown.extensions.toc:
slugify: !!python/object/apply:pymdownx.slugs.slugify { kwds: { case: lower } }
permalink: ""
- markdown.extensions.admonition:
- markdown.extensions.smarty:
smart_quotes: false
- pymdownx.betterem:
- pymdownx.keys
- markdown.extensions.attr_list:
- markdown.extensions.def_list:
- markdown.extensions.tables:
- markdown.extensions.abbr:
- markdown.extensions.footnotes:
- markdown.extensions.md_in_html:
- pymdownx.superfences:
preserve_tabs: true
custom_fences:
# Mermaid diagrams
# Please recall that fence must match Obsidian mermaid plugin
- name: mermaid
class: diagram
format: !!python/name:pymdownx.superfences.fence_code_format
# - name: math
# class: arithmatex
# format:
# !!python/object/apply:pymdownx.arithmatex.arithmatex_fenced_format { kwds: { mode: generic, tag: pre } }
# - name: md-render
# class: md-render
# format: !!python/name:tools.pymdownx_md_render.md_sub_render
# Vega Lite charts
#
# Please recall that fence must match Vega/Vega-Lite Obsidian
# plugin https://github.com/Justin-J-K/obsidian-vega
# (In above Obsidian plugin, fences cannot be changed.)
- name: vega-lite
class: vegalite
format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite # Vega-Lite charts
- name: vega
class: vegalite
format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite # Vega charts
- pymdownx.highlight:
extend_pygments_lang:
- name: js
lang: js
- name: pycon3
lang: pycon
options:
python3: true
linenums_style: pymdownx-inline
- pymdownx.inlinehilite:
custom_inline:
- name: math
class: arithmatex
format: !!python/object/apply:pymdownx.arithmatex.arithmatex_inline_format { kwds: { mode: generic } }
- pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
social_url_shorthand: true
social_url_shortener: true
user: facelessuser
repo: pymdown-extensions
normalize_issue_symbols: true
- pymdownx.tilde:
- pymdownx.caret:
- pymdownx.smartsymbols:
# - pymdownx.emoji:
# emoji_index: !!python/name:material.extensions.emoji.twemoji
# emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.escapeall:
hardbreak: True
nbsp: True
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.progressbar:
# - pymdownx.arithmatex:
# generic: true
# block_tag: "pre"
- pymdownx.mark:
- pymdownx.striphtml:
# - pymdownx.snippets:
# base_path:
# - docs/src/markdown/.snippets
# - LICENSE.md
# - SECURITY.md
# auto_append:
# - refs.md
# check_paths: true
# - pymdownx.keys:
# separator: "\uff0b"
- pymdownx.details:
- pymdownx.tabbed:
alternate_style: true
- pymdownx.saneheaders:
- pymdownx.blocks.admonition:
types:
- new
- settings
- note
- abstract
- info
- tip
- success
- question
- warning
- failure
- danger
- bug
- example
- quote
- pymdownx.blocks.details:
types:
- name: details-new
class: new
- name: details-settings
class: settings
- name: details-note
class: note
- name: details-abstract
class: abstract
- name: details-info
class: info
- name: details-tip
class: tip
- name: details-success
class: success
- name: details-question
class: question
- name: details-warning
class: warning
- name: details-failure
class: failure
- name: details-danger
class: danger
- name: details-bug
class: bug
- name: details-example
class: example
- name: details-quote
class: quote
- pymdownx.blocks.html:
- pymdownx.blocks.definition:
- pymdownx.blocks.tab:
alternate_style: True
combine_header_slug: True
slugify: !!python/object/apply:pymdownx.slugs.slugify { kwds: { case: lower } }
# - tools.collapse_code:
# expand_text: ""
# collapse_text: ""
# ###############################################
#
# Extras
#
extra_javascript:
- assets/js/extra-loader.js
# - assets/js/material-extra-3rdparty.js
# - assets/js/material-extra-theme.js
- https://unpkg.com/mermaid/dist/mermaid.min.js
- https://cdn.jsdelivr.net/npm/vega@5
- https://cdn.jsdelivr.net/npm/vega-lite@5
- https://cdn.jsdelivr.net/npm/vega-embed@6
extra_css:
# - assets/css/extra.css
# - assets/css/fonts.css
# - assets/css/dracula-colors.css
- assets/css/image-align.css