Pylux/mkdocs.yml at master · ForWard-Technologies-LLC/Pylux · 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
site_name: Pylux
repo_url: https://github.com/ForWard-Technologies-LLC/Pylux
site_url: https://forward-technologies-llc.github.io/Pylux/
edit_uri: edit/master/docs
nav:
  - Home: index.md
  - Setup:
    - Setup Overview: setup/index.md
    - Installation: setup/installation.md
    - Configuration: setup/configuration.md
    - Remote Connection: setup/remoteconnection.md
    - Controller Options: setup/controlling.md

theme:
  favicon: images/pylux-icon.png
  logo: images/pylux-icon.png
  features:
    - header.autohide
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.footer
    - search.share
    - navigation.indexes
    - announce.dismiss
    - content.tabs.link
    - content.code.copy
    - content.action.edit
    - content.action.view

  name: material
  palette:
    - media: "(prefers-color-scheme: dark)"
      primary: black
      accent: lime
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    - media: "(prefers-color-scheme: light)"
      primary: black
      accent: lime
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

copyright: >
  Copyright &copy; 2024 ForWard Technologies LLC –
  <a href="#__consent">Change cookie settings</a>

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ForWard-Technologies-LLC/Pylux

  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make the documentation better.

markdown_extensions:
  - abbr
  - admonition
  - codehilite
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tilde
  - attr_list
  - tables
  - toc:
      permalink: true
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true