-
Notifications
You must be signed in to change notification settings - Fork 28
/
mkdocs.yml
executable file
·175 lines (168 loc) · 6.87 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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
site_name: Lyrion Music Server
site_url: https://lyrion.org/
repo_url: https://github.com/lms-community/slimserver
edit_uri: https://github.com/lms-community/lms-community.github.io/edit/main/docs/
exclude_docs: |
downloads.yaml
theme:
name: material
logo: assets/logo.png
favicon: assets/favicon.png
language: en
features:
- content.action.edit
- content.action.view
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.path
- navigation.expand
- navigation.sections
# Not compatible in combination with privacy feature and mkdocs-charts-plugin
#- navigation.instant
#- navigation.instant.progress
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
toggle:
icon: material/brightness-4
name: Switch to system preference
plugins:
- search
- privacy
- charts
- macros:
include_yaml:
- docs/downloads/downloads.yaml
- docs/players-and-controllers/firmware-versions.yaml
extra_javascript:
- https://cdn.jsdelivr.net/npm/vega@5
- https://cdn.jsdelivr.net/npm/vega-lite@5
- https://cdn.jsdelivr.net/npm/vega-embed@6
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/LMS-Community/slimserver
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/lmscommunity/lyrionmusicserver
- icon: simple/vbulletin
link: https://forums.slimdevices.com
copyright: <a href="/downloads">Downloads</a> | <a href="/analytics">Analytics</a>
# tabbed content
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: vegalite
class: vegalite
format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite
- pymdownx.tabbed:
alternate_style: true
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
nav:
- Home: index.md
- Getting Started with LMS:
- Download & Installation: getting-started/index.md
- Migrate from UE Smart Radio:
- English: getting-started/migrate-from-uesr.md
- Deutsch: getting-started/migrate-from-uesr-de.md
- Beginner's guides:
- Beginner's guide for LMS: getting-started/beginners-guide-lms-on-raspberry-pi.md
- Beginner's guide for a full-featured LMS: getting-started/beginners-guide-full-featured-lms-on-raspberry-pi.md
- Beginner's Docker guide on Synology: getting-started/beginners-guide-synology-docker.md
- Beginner's Docker guide on QNAP: getting-started/beginners-guide-qnap-docker.md
- Advanced guides:
- Use OpenVPN on SB Touch/Radio: getting-started/advanced-guide-openvpn.md
- Changelog:
- LMS 8 changelog: getting-started/changelog-lms8.md
- LMS 9 changelog: getting-started/changelog-lms9.md
- Players & Controllers:
- players-and-controllers/index.md
- Hardware based:
- Hardware Comparison: players-and-controllers/hardware-comparison.md
- Squeezebox Touch: players-and-controllers/squeezebox-touch.md
- Squeezebox Radio: players-and-controllers/squeezebox-radio.md
- Squeezebox Boom: players-and-controllers/squeezebox-boom.md
- Squeezebox Duet:
- Squeezebox Controller: players-and-controllers/squeezebox-controller.md
- Squeezebox Receiver: players-and-controllers/squeezebox-receiver.md
- Transporter: players-and-controllers/transporter.md
- Squeezebox Classic: players-and-controllers/squeezebox-classic.md
- Squeezebox 2: players-and-controllers/squeezebox2.md
- Squeezebox 1: players-and-controllers/squeezebox1.md
- SLIMP3: players-and-controllers/SLIMP3.md
- Software based:
- Software Comparison: players-and-controllers/software-comparison.md
- Squeezelite: players-and-controllers/squeezelite.md
- Squeezelite manpage: players-and-controllers/squeezelite-manpage.md
- Jivelite: players-and-controllers/jivelite.md
- SqueezePlay: players-and-controllers/squeezeplay.md
- SoftSqueeze: players-and-controllers/softsqueeze.md
- piCorePlayer: players-and-controllers/picoreplayer.md
- Plugins:
- Overview: plugins/index.md
- Available Plugins: plugins/directory.md
- Repository File Reference: reference/repository-dev.md
- Contributing:
- Overview: contributing/index.md
- Reporting a bug: contributing/reporting-a-bug.md
- Adding translations: contributing/adding-translations.md
- Community forums: https://forums.slimdevices.com/
- Reference:
- Lyrion Music Server: reference/lyrion-music-server.md
- Legacy Mac Uninstall: reference/uninstall-legacy-mac.md
- Command Line Interface (JSON/RPC):
- Introduction: reference/cli/introduction.md
- Using the CLI: reference/cli/using-the-cli.md
- General: reference/cli/general.md
- Players: reference/cli/players.md
- Database: reference/cli/database.md
- Playlist: reference/cli/playlist.md
- Favorites: reference/cli/favorites.md
- Randomplay: reference/cli/randomplay.md
- Compound Queries: reference/cli/compoundqueries.md
- Notifications: reference/cli/notifications.md
- Alarms: reference/cli/alarms.md
- Docker:
- Add locales to the Docker container: reference/add-locales-to-docker.md
- Plugins/applets:
- Squeezeplay Applet:
- Applet Development: reference/squeezeplay-applet.md
- Installing Applets: reference/installing-applets.md
- Music Service Plugin: reference/music-service-plugin.md
- Plugin/Applet Repositories: reference/repository-dev.md
- Development:
- Database Structure: reference/database-structure.md
- SlimProto Protocol: reference/slimproto-protocol.md
- SLIMP3 Protocol: reference/slimp3-protocol.md
- Classic/Boom/Transporter Graphics: reference/ip3k-graphics.md
- SqueezePlay Menu System:
- Home Menu vs. SlimBrowse: reference/home-vs-slimbrowse.md
- Home Menu Items: reference/adding-menus-squeezeplay.md
- SlimBrowse Protocol: reference/slimbrowse.md
- SSH/SCP:
- Enable SSH Access to the Squeezebox: reference/enable-ssh.md
- WinSCP How To: reference/winscp.md
- "#CURTRACK Guide": reference/curtrack.md
- Special IR Keys: reference/special-ir-keys-reset.md
- Custom Firmware: reference/custom-firmware.md
- Custom OS support: reference/slim-utils-os-custom.md