deepcube-docs/mkdocs.dev.yml at main · ImmersiveFusion/deepcube-docs · GitHub

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
# Dev config - fast rebuilds without slow plugins
# Usage: python -m mkdocs serve -f mkdocs.dev.yml
# Note: not using INHERIT because MkDocs 1.x merges plugin lists
# Keep in sync with: ../IF.Knowledge/src/nexus/IF.Knowledge.Nexus.Spa/mkdocs.dev.yml

site_name: DeepCube Docs
site_url: https://docs.immersivefusion.com
site_description: DeepCube&trade;. The spatial observability platform.
site_author: Immersive Fusion LLC

repo_name: deepcube-docs
repo_url: https://github.com/ImmersiveFusion/deepcube-docs
edit_uri: edit/main/docs

copyright: Copyright &copy; 2020-2026 <a href="https://www.immersivefusion.com">Immersive Fusion LLC</a>, Maintained by the <a href="/contact/">Immersive Team</a>. Some content generation and supplementation using GPT through Azure OpenAI

watch:
  - docs
  - overrides

theme:
  name: material
  custom_dir: overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - scheme: slate
      primary: black
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    header: Josefin Sans
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.png
  logo: assets/logo.png

# Fast plugins only - no git-revision-date-localized, no minify
hooks:
  # Derives a page's meta description from its own opening paragraph when
  # the page does not declare one. Explicit front matter always wins.
  - hooks/meta_descriptions.py

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - awesome-pages

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - markdown_include.include:
      base_path: docs

extra_javascript: []
extra_css:
  - css/extra.css

extra:
  homepage: /
  annotate:
    json: [.s2]