---

site_name: "What's Now Playing"

site_description: "A tool to retrieve current/last played song in DJ software"

site_url: http://whatsnowplaying.github.io

repo_url: https://github.com/whatsnowplaying/whats-now-playing

repo_name: whatsnowplaying/whats-now-playing

edit_uri: edit/main/docs/

theme:

name: materialx

custom_dir: overrides

topbar_style: primary

palette:

# Palette toggle for light mode

- media: "(prefers-color-scheme: light)"

scheme: default

primary: blue

accent: blue

toggle:

icon: material/brightness-7

name: Switch to dark mode

# Palette toggle for dark mode

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: blue

accent: blue

toggle:

icon: material/brightness-4

name: Switch to light mode

features:

- navigation.path

- navigation.top

- navigation.tracking

- search.highlight

- search.share

- search.suggest

- content.code.copy

- content.action.agents

- toc.follow

- toc.integrate

plugins:

- search

- macros:

module_name: docs/macros

render_by_default: true

j2_variable_start_string: '{$'

j2_variable_end_string: '$}'

- mike:

version_selector: true

css_dir: css

javascript_dir: js

extra:

version:

provider: mike

default: latest

warning:

- version: dev

text: "⚠️ Development version - features may be unstable"

url: ../latest/

social:

- icon: fontawesome/brands/github

link: https://github.com/whatsnowplaying/whats-now-playing

markdown_extensions:

- admonition

- pymdownx.details

- pymdownx.superfences

- pymdownx.tabbed:

alternate_style: true

- attr_list

- md_in_html

- material.extensions.code_download

- toc:

permalink: true

hooks:

- properdocs_hooks.py

docs_dir: docs

site_dir: site

watch:

- CHANGELOG.md

nav:

- Home: index.md

- Features: features.md

- Quickstart: quickstart.md

- Usage: usage.md

- Upgrading: upgrading.md

- Changelog: changelog.md

- Core Settings:

- General: settings/index.md

- Source: input/index.md

- Filters: settings/filter.md

- Track Skip: settings/trackskip.md

- Input Sources:

- Denon: input/denon.md

- djay Pro: input/djaypro.md

- DJUCED: input/djuced.md

- Icecast: input/icecast.md

- JRiver: input/jriver.md

- M3U: input/m3u.md

- MIXXX: input/mixxx.md

- MPRIS2: input/mpris2.md

- EarShot: input/earshot.md

- Remote: input/remote.md

- Serato: input/serato.md

- Serato (Legacy): input/serato3.md

- Traktor: input/traktor.md

- Virtual DJ: input/virtualdj.md

- Windows Media: input/winmedia.md

- Output & Display:

- Overview: output/index.md

- Charts: output/charts.md

- Export for OBS: output/obs-export.md

- OBS WebSocket: output/obswebsocket.md

- Text Output: output/textoutput.md

- Web Server: output/webserver.md

- Streaming & Chat:

- Discord: output/discord.md

- Kick Bot: output/kickbot.md

- Twitch Bot: output/twitchbot.md

- Guess Game: output/guessgame.md

- Requests: requests.md

- Recognition:

- Overview: recognition/index.md

- AcoustID: recognition/acoustid.md

- MusicBrainz: recognition/musicbrainz.md

- Artist Data:

- Overview: extras/index.md

- Discogs: extras/discogs.md

- FanArt.TV: extras/fanarttv.md

- Last.fm: extras/lastfm.md

- TheAudioDB: extras/theaudiodb.md

- Wikimedia: extras/wikimedia.md

- System:

- Quirks: settings/quirks.md

- Destroy: settings/destroy.md

- Help:

- Overview: help/index.md

- How Do I?: help/howdoi.md

- Linux Setup: help/linux.md

- Accuracy: help/accuracy.md

- Troubleshooting: help/troubleshooting.md

- Bug Reports: help/bugreports.md

- Open Source: help/opensource.md

- Reference:

- Overview: reference/index.md

- API Reference: reference/api.md

- Template Variables: reference/templatevariables.md

- Template Reference: reference/templates.md

- Gallery:

- Overview: gallery/index.md

- Webserver Templates: gallery/webserver.md

- WebGL Templates: gallery/webgl.md

- OBS WebSocket: gallery/obswebsocket.md

- Unicode Support: gallery/unicode.md

- Developers: help/developers.md

- Contact: contact.md