Documentation for PyDeck — a Python-powered, web-based macro deck that lets you trigger actions from buttons in a browser UI.
Live site: docs.pydeck.no
This repository contains the official developer documentation for PyDeck. It covers how to extend PyDeck through plugins and themes, and how to maintain a plugin catalog for the marketplace.
The docs live in the docs/ folder and are published to docs.pydeck.no via GitHub Pages. The published landing page is docs/index.md (installation and run instructions).
| Page | Path |
|---|---|
| Installation (home) | docs/index.md |
| Topic | Path |
|---|---|
| Marketplace & catalog | docs/using/marketplace.md |
| Gradient backgrounds | docs/using/gradient-backgrounds.md |
| Discord (official plugin) | docs/using/discord.md |
| Spotify (official plugin) | docs/using/spotify.md |
authentication.md, web-ui-and-assets.md, http-api-reference.md (credentials, web UI integration, HTTP/WebSocket).
Entry: getting-started.md. Additional chapters: templates-elements.md, rendering.md, runtime-examples.md.
Entry: getting-started.md. Additional chapters: core.md (classic plugin.py and built-in renderer), examples.md.
docs/plugin-development/catalog/ — pydeck-plugins repo tooling
| File | Description |
|---|---|
pdk-create.md |
Scaffold a new PDK plugin (python -m tools.pdk_create). |
generate-manifest.md |
Regenerate the root manifest.json from the plugins/ tree. |
sync-from-pydeck.md |
Sync plugin sources from a local PyDeck checkout into the catalog. |
release-stable.md |
Promote canary to stable on the catalog repo. |
Entry: getting-started.md. Additional chapters: css-reference.md, loader-examples.md, marketplace-catalog.md (how theme releases use the shared pydeck-plugins catalog scripts).
Navigation order and labels are defined in mkdocs.yml.
| Repo | Description |
|---|---|
opvault/pydeck |
The main PyDeck application (FastAPI server, web UI, hardware listener). |
opvault/pydeck-plugins |
The official plugin catalog repo used by the PyDeck marketplace. |