docs/mkdocs.yml at main · tronbyt/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
site_name: Tronbyt Docs
site_url: https://tronbyt.com
site_author: Tronbyt
site_description: Tronbyt is an open source connected, smart display that shows weather, stocks, sports, and a whole lot more.

repo_name: !ENV [REPO_NAME, "tronbyt/docs"]
repo_url: !ENV [REPO_URL, "https://github.com/tronbyt/docs"]
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: overrides
  font: false
  logo: icons/logo.svg
  favicon: icons/favicon.ico
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: lucide/sun-moon
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: lucide/sun
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: lucide/moon-star
        name: Switch to system preference
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tooltips
    - content.action.edit
  icon:
    repo: fontawesome/brands/github
    edit: lucide/file-pen

plugins:
  - search
  - privacy
  - git-revision-date-localized:
      type: timeago
  - minify:
      minify_html: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true
  - social

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - toc:
      permalink: true
      toc_depth: 3

nav:
  - index.md
  - Tronbyt:
    - what-is-tronbyt.md
    - getting-started.md
    - tronbyt-manager.md
    - configuration.md
    - device-notes.md
  - Pixlet:
    - pixlet/getting-started.md
    - pixlet/installing.md
    - pixlet/authoring-apps.md
    - pixlet/pushing-apps.md
    - Tutorials:
      - pixlet/tutorials/clock-app.md
      - pixlet/tutorials/crypto-tracker.md
    - Reference:
      - pixlet/reference/widgets.md
      - pixlet/reference/modules.md
      - pixlet/reference/animations.md
      - pixlet/reference/fonts.md
      - pixlet/reference/emoji.md
      - pixlet/reference/filters.md
      - pixlet/reference/gifs.md
      - pixlet/reference/2x-apps.md
      - pixlet/reference/i18n.md
      - pixlet/reference/schema/schema.md
    - Publish:
      - pixlet/publish/community-apps.md
      - pixlet/publish/publishing-apps.md
      - pixlet/publish/modifying-apps.md
      - pixlet/publish/advanced.md
      - pixlet/publish/faq.md
  - Community:
    - community/index.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tronbyt
    - icon: fontawesome/brands/discord
      link: /discord/

watch:
  - overrides