diff --git a/docs/blog/2024-11-11-zmk-studio-mvp-ga.mdx b/docs/blog/2024-11-11-zmk-studio-mvp-ga.mdx new file mode 100644 index 000000000..8c4cac438 --- /dev/null +++ b/docs/blog/2024-11-11-zmk-studio-mvp-ga.mdx @@ -0,0 +1,261 @@ +--- +title: "ZMK Studio MVP General Availability" +authors: petejohanson +tags: [firmware, studio, core] +--- + +import Metadata from "@site/src/data/hardware-metadata.json"; + +import ThemedImage from "@theme/ThemedImage"; + +import studioApp from "./assets/2024-11-11-zmk-studio-mvp-ga/zmk-studio-screenshot.png"; +import studioAppDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/zmk-studio-screenshot-dark-mode.png"; + +import niceAndTyperactive from "./assets/2024-11-11-zmk-studio-mvp-ga/niceandtyperactive.png"; +import niceAndTyperactiveDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/niceandtyperactive-dark-mode.png"; + +import kinesis from "./assets/2024-11-11-zmk-studio-mvp-ga/kinesis.png"; +import kinesisDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/kinesis-dark-mode.png"; + +import cannonKeys from "./assets/2024-11-11-zmk-studio-mvp-ga/cannonkeys.png"; +import cannonKeysDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/cannonkeys-dark-mode.png"; + +import keychron from "./assets/2024-11-11-zmk-studio-mvp-ga/keychron.png"; +import keychronDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/keychron-dark-mode.png"; + +import littleKeyboards from "./assets/2024-11-11-zmk-studio-mvp-ga/littlekeyboards.avif"; +import littleKeyboardsDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/littlekeyboards-dark-mode.avif"; + +import keebmaker from "./assets/2024-11-11-zmk-studio-mvp-ga/keebmaker.png"; +import keebmakerDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/keebmaker-dark-mode.png"; + +import keebio from "./assets/2024-11-11-zmk-studio-mvp-ga/keebio.avif"; + +import mode from "./assets/2024-11-11-zmk-studio-mvp-ga/mode.png"; +import modeDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/mode-dark-mode.png"; + +import phaseByte from "./assets/2024-11-11-zmk-studio-mvp-ga/phasebyte.png"; + +import deskHero from "./assets/2024-11-11-zmk-studio-mvp-ga/deskhero.webp"; +import deskHeroDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/deskhero-dark-mode.webp"; + +import mechlovin from "./assets/2024-11-11-zmk-studio-mvp-ga/mechlovin.png"; +import mechlovinDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/mechlovin-dark-mode.png"; + +import splitkb from "./assets/2024-11-11-zmk-studio-mvp-ga/splitkb.png"; +import splitkbDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/splitkb-dark-mode.png"; + +import keycapsss from "./assets/2024-11-11-zmk-studio-mvp-ga/keycapsss.png"; +import keycapsssDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/keycapsss-dark-mode.png"; + +import mekibo from "./assets/2024-11-11-zmk-studio-mvp-ga/mekibo.png"; +import mekiboDarkMode from "./assets/2024-11-11-zmk-studio-mvp-ga/mekibo-dark-mode.png"; + +I'm delighted to announce that after many months of work, the ZMK Studio Minimum Viable Product (MVP) has reached General Availability (GA) status. I'm very excited with the feature set and foundation we've gotten into this first release, and equally excited for the upcoming work to add even more features. + +ZMK Studio provides runtime keymap functionality for ZMK powered devices, allowing you to make changes without the need to flash new firmware. It is a combination of major firmware enhancements paired with a new frontend application for interacting with your keyboard. + +The app is available for compatible browsers, and as an installable desktop application for Linux, macOS, and Windows. + + + +{/* truncate */} + +## Gratitude + +I'm extremely grateful for everyone who has helped make this release possible, which includes testers, code reviewers/contributors, including [Nick-Munnich], [joelspadin], and [caksoylar], as well as the collection of vendors who have directly sponsored my work on the project, allowing it to come to fruition _much_ faster than it would have taken me to do in my spare time. + +### Vendor Sponsors + +The following sponsors were instrumental in making ZMK Studio possible by sponsoring my work on the firmware and frontend application: + +{(function() { +const sponsors = [ +{ +level: "Platinum", +vendors: [ +{ +name: "nice!keyboards / typeractive", +img: niceAndTyperactive, +darkModeImg: niceAndTyperactiveDarkMode, +url: "https://typeractive.xyz/", +}, +{ +name: "Kinesis", +img: kinesis, +darkModeImg: kinesisDarkMode, +url: "https://kinesis-ergo.com/", +}, +], +}, +{ +level: "Gold+", +vendors: [ +{ +name: "CannonKeys", +img: cannonKeys, +darkModeImg: cannonKeysDarkMode, +url: "https://cannonkeys.com/", +}, +{ +name: "Keychron", +img: keychron, +darkModeImg: keychronDarkMode, +url: "https://keychron.com/", +}, +], +}, +{ +level: "Gold", +vendors: [ +{ +name: "Little Keyboards", +img: littleKeyboards, +darkModeImg: littleKeyboardsDarkMode, +url: "https://littlekeyboards.com/", +}, +{ +name: "Keebmaker", +img: keebmaker, +darkModeImg: keebmakerDarkMode, +url: "https://keebmaker.com/", +}, +], +}, +{ +level: "Silver", +vendors: [ +{ +name: "keeb.io", +img: keebio, +url: "https://keeb.io/", +}, +{ +name: "Mode Designs", +img: mode, +darkModeImg: modeDarkMode, +url: "https://modedesigns.com/", +}, +], +}, +{ +level: "Bronze", +vendors: [ +{ +name: "deskhero", +img: deskHero, +darkModeImg: deskHeroDarkMode, +url: "https://deskhero.ca/", +}, +{ +name: "PhaseByte", +img: phaseByte, +url: "https://phasebyte.com/", +}, +{ +name: "Mechlovin'", +img: mechlovin, +darkModeImg: mechlovinDarkMode, +url: "https://mechlovin.studio/", +}, +], +}, +{ +level: "Additional", +vendors: [ +{ +name: "splitkb.com", +img: splitkb, +darkModeImg: splitkbDarkMode, +url: "https://splitkb.com/", +}, +{ +name: "keycapsss", +img: keycapsss, +darkModeImg: keycapsssDarkMode, +url: "https://keycapsss.com/", +}, +{ +name: "mekibo", +img: mekibo, +darkModeImg: mekiboDarkMode, +url: "https://mekibo.com/", +}, +], +}, +]; + +return sponsors.map(g => { +return ( + +
+

{g.level} Level

+
+ {g.vendors.map((v) => { + return ( + + + + ); + })} +
+
+); }); }())} + +## Using ZMK Studio + +:::note + +For keyboard maintainers, additional changes are needed to add metadata about the keyboard's physical layouts in order to use ZMK Studio. See the documentation on [physical layouts](/docs/development/hardware-integration/physical-layouts#optional-keys-property) for more information. +::: + +To use ZMK Studio, you need to have a firmware for your keyboard with the feature enabled, as well as a small keymap change to add an unlock key. See [Building with ZMK Studio](/docs/features/studio#building) and [ZMK Studio keymap changes](/docs/features/studio#keymap-changes) for more details. + +See [Accessing ZMK Studio](/docs/features/studio#accessing-zmk-studio) for more details on the browser and desktop options for using the ZMK Studio application. +Note: Depending on your browser, operating system, and app vs website selection, you may be limited to connecting over USB. See the previous link for details. + +## In-Tree Supported Keyboards + +The following in-tree keyboards have been updated to support ZMK Studio. +If your keyboard is supported by an external module/config, check with the maintainer to see +if support has been added. + +{(function() { +return ( + + +); }())} + +## Next Steps + +The ZMK Studio MVP is truly that, a "minimum viable product". It establishes the core firmware functionality and frontend application infrastructure in order to validate the technology, prove the approaches, and get initial core features into user's hands as early as possible. + +There are many ZMK features that are not yet possible to update in ZMK Studio. For a better understanding of where ZMK Studio is today, and where we are headed, please have a look at the [ZMK Studio capabilities](/docs/features/studio#capabilities) table. + +[petejohanson]: https://github.com/petejohanson +[caksoylar]: https://github.com/caksoylar +[Nick-Munnich]: https://github.com/Nick-Munnich +[joelspadin]: https://github.com/joelspadin diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/cannonkeys-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/cannonkeys-dark-mode.png new file mode 100644 index 000000000..9c5b7475c Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/cannonkeys-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/cannonkeys.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/cannonkeys.png new file mode 100644 index 000000000..fa9ab2c91 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/cannonkeys.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/deskhero-dark-mode.webp b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/deskhero-dark-mode.webp new file mode 100644 index 000000000..68ad35e1b Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/deskhero-dark-mode.webp differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/deskhero.webp b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/deskhero.webp new file mode 100644 index 000000000..99018cf0d Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/deskhero.webp differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keebio.avif b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keebio.avif new file mode 100644 index 000000000..294182ec6 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keebio.avif differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keebmaker-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keebmaker-dark-mode.png new file mode 100644 index 000000000..d8b6b487a Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keebmaker-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keebmaker.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keebmaker.png new file mode 100644 index 000000000..4341f09a5 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keebmaker.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keycapsss-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keycapsss-dark-mode.png new file mode 100644 index 000000000..28a0eb6c0 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keycapsss-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keycapsss.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keycapsss.png new file mode 100644 index 000000000..b91589527 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keycapsss.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keychron-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keychron-dark-mode.png new file mode 100644 index 000000000..173b8103f Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keychron-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keychron.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keychron.png new file mode 100644 index 000000000..26773f1fe Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/keychron.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/kinesis-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/kinesis-dark-mode.png new file mode 100644 index 000000000..617f25685 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/kinesis-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/kinesis.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/kinesis.png new file mode 100644 index 000000000..15617580a Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/kinesis.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/littlekeyboards-dark-mode.avif b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/littlekeyboards-dark-mode.avif new file mode 100644 index 000000000..fd8159b7c Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/littlekeyboards-dark-mode.avif differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/littlekeyboards.avif b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/littlekeyboards.avif new file mode 100644 index 000000000..957b4d7af Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/littlekeyboards.avif differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mechlovin-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mechlovin-dark-mode.png new file mode 100644 index 000000000..b1951c20d Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mechlovin-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mechlovin.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mechlovin.png new file mode 100644 index 000000000..136a03eab Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mechlovin.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mekibo-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mekibo-dark-mode.png new file mode 100644 index 000000000..7058937e1 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mekibo-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mekibo.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mekibo.png new file mode 100644 index 000000000..dcfdee9fc Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mekibo.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mode-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mode-dark-mode.png new file mode 100644 index 000000000..27d8a73ad Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mode-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mode.png new file mode 100644 index 000000000..fd8f8db47 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/niceandtyperactive-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/niceandtyperactive-dark-mode.png new file mode 100644 index 000000000..394995085 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/niceandtyperactive-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/niceandtyperactive.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/niceandtyperactive.png new file mode 100644 index 000000000..8172555b2 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/niceandtyperactive.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/phasebyte.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/phasebyte.png new file mode 100644 index 000000000..69259103b Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/phasebyte.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/splitkb-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/splitkb-dark-mode.png new file mode 100644 index 000000000..ec0e32048 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/splitkb-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/splitkb.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/splitkb.png new file mode 100644 index 000000000..cb4ff84fc Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/splitkb.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/zmk-studio-screenshot-dark-mode.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/zmk-studio-screenshot-dark-mode.png new file mode 100644 index 000000000..e06235580 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/zmk-studio-screenshot-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/zmk-studio-screenshot.png b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/zmk-studio-screenshot.png new file mode 100644 index 000000000..c4ada3778 Binary files /dev/null and b/docs/blog/assets/2024-11-11-zmk-studio-mvp-ga/zmk-studio-screenshot.png differ