forked from Aircoookie/WLED-Docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
112 lines (112 loc) · 3.62 KB
/
mkdocs.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
site_name: WLED Project
site_author: Christian Schwinne (Aircoookie)
#site_url: https://wled.app
repo_name: WLED
repo_url: https://github.com/Aircoookie/WLED
repo_title: WLED Repository
#copyright: Copyright © 2016-2021 Christian Schwinne, Contributors
edit_uri: https://github.com/Aircoookie/WLED-Docs/edit/master/docs
theme:
name: material
custom_dir: docs/assets/overrides
language: en
favicon: assets/images/ui/aircoookie/blurple.png
logo: assets/images/ui/akemi/001_cheerful.png
icon:
repo: fontawesome/brands/github
features:
- navigation.top
# - navigation.expand
- navigation.instant
- navigation.tabs
# - toc.integrate
palette:
- scheme: wled
primary: cyan #mostly overriden in extra.css
accent: orange
toggle:
icon: material/weather-sunny
name: Light Mode
- scheme: default
primary: orange
accent: orange
toggle:
icon: material/weather-night
name: Dark Mode
plugins:
- search
markdown_extensions:
- admonition
- attr_list
- pymdownx.highlight
extra:
social:
- icon: fontawesome/brands/discord
link: https://discord.gg/KuqP7NE
name: Discord
- icon: fontawesome/brands/discourse
link: https://wled.discourse.group/
name: Forum
- icon: fontawesome/solid/code
link: https://gitpod.io/#https://github.com/Aircoookie/WLED
name: Gitpod
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/wled_project/
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/results?search_query=WLED
- icon: fontawesome/solid/tshirt
link: https://wled.teemill.com/
- icon: fontawesome/solid/heart
link: https://paypal.me/aircoookie/
extra_css:
- assets/stylesheets/global.css
- assets/stylesheets/extra.css
extra_javascript:
- assets/js/newtab.js
nav:
- Welcome: index.md
- Basics:
- Getting Started: basics/getting-started.md
- Compatibility:
- Hardware: basics/compatible-hardware.md
- Software: basics/compatible-software.md
- Installation:
- Install WLED Binary: basics/install-binary.md
- Install using ESP GUI: basics/install-gui.md
- Compiling WLED: basics/compiling-wled.md
- Tutorials: basics/tutorials.md
- FAQ: basics/faq.md
- Features:
- Effects & Palettes: features/effects-palettes.md
- Macros: features/macros.md
- Presets: features/presets.md
- Segments: features/segments.md
- Settings: features/settings.md
- Multi-strip Support: features/multi-strip.md
- Relay Control: features/relay-control.md
- Web GUI Sitemap: features/subpages.md
- Interfaces:
- Blynk: interfaces/blynk.md
- DMX: interfaces/dmx-output.md
- E1.31 (DMX) / Art-Net: interfaces/e1.31-dmx.md
- HTTP Request API: interfaces/http-api.md
- JSON API: interfaces/json-api.md
- MQTT: interfaces/mqtt.md
- Infrared: interfaces/infrared.md
- Philips Hue: interfaces/philips-hue.md
- WLED UDP Sync: interfaces/udp-notifier.md
- UDP Realtime / tpm2.net: interfaces/udp-realtime.md
- Websocket: interfaces/websocket.md
- Advanced:
- Home Automation: advanced/home-automation.md
- Remote Access / IFTTT: advanced/remote-access-ifttt.md
- Security: advanced/security.md
- Wiring Protips: advanced/wiring.md
- Compile WLED: advanced/compile-wled.md
- Custom Features: advanced/custom-features.md
- ESP32 Recovery: advanced/esp32-recovery.md
- Mapping: advanced/mapping.md
- About:
- Contributors & Credits: about/contributors.md
- Privacy Policy: about/privacy-policy.md
- Upcoming Features: about/roadmap.md