Documentation/mkdocs.yml at main · FutureProofHomes/Documentation · 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
131
132
133
134
site_name: FutureProofHomes Docs
site_url: https://docs.futureproofhomes.net
repo_url: https://github.com/FutureProofHomes/Documentation
nav:
  - Welcome: index.md
  - Satellite1 Dev Kit:
    - Introduction: satellite1-introduction.md
    - PCB Assembly & First Boot: satellite1-assembly.md
    - Connect to Home Assistant: satellite1-connecting-to-ha.md
    - Set Up Voice Pipeline: satellite1-set-up-voice-control.md
    - Enclosures & Speaker Kits:
      - OEM Kits:
        - Smart Speaker Kit: satellite1-smart-speaker-enclosure-kit.md
        - In-Ceiling Mount Kit: satellite1-mount-kit-overview.md
      - DIY Enclosures:
        - Squircle Enclosures: satellite1-squircle-enclosures.md
        - Cylindrical Enclosure: satellite1-cylindrical-enclosure.md
    - Streaming Music: satellite1-streaming-music.md
    - Helpful Automations: satellite1-helpful-automations.md
    - Flashing Firmware:
      - Flash via USB-C Cable: satellite1-flash-via-usb-c.md
      - Modifying the Firmware: satellite1-modifying-the-firmware.md
    - Adding Presence Sensors: satellite1-presence-sensors.md
    - Expansion Modules:
      - PoE1 Module: satellite1-poe-shoe-module-overview.md
      - Amplifier1 Module: satellite1-amplifier-module-overview.md
    - FAQs & Troubleshooting: satellite1-faqs.md
  - Nexus1 AI Base Station:
    - Introduction: ai-base-station-introduction.md


theme:
  logo: assets/square_transparent_black_logo_vector_300x300.svg
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.top
    - navigation.expand
    - navigation.tracking
    - navigation.prune

    # - toc.integrate

    - search.suggest
    - search.highlight
    # - search.share
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  palette:
    - scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
      primary: custom
      accent: custom
    - scheme: default
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
      primary: custom
      accent: custom
extra_css:
  - stylesheets/extra.css
  - stylesheets/firmware_selector.css
extra:
  social:
    # - icon: fontawesome/icon/home
    #   link: https://futureproofhomes.net
    - icon: fontawesome/brands/github-alt
      link: https://github.com/FutureProofHomes
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@futureproofhomes
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/AIVoiceAssist
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/futureproofhome

markdown_extensions:
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.magiclink
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  # - optimize
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - custom-skip-class-name
      auto_caption: false
      caption_position: bottom
      background: white
      shadow: true
      manual: false

extra_javascript:
  # - javascript/installer.js
  - javascript/esp-web-tools/install-button.js
  # - https://cdn.jsdelivr.net/npm/esp-web-tools@10/dist/web/install-button.js?module
  - javascript/keyboard_shortcuts_fix.js
  - javascript/firmware_selector.js
  - javascript/faq-expand-on-hash.js

copyright: |
  &copy; 2024 <a href="https://futureproofhomes.net" target="_blank" rel="noopener">FutureProofHomes, Inc</a>