diff --git a/docs/blog/2024-11-15-zmk-studio-mvp-ga.mdx b/docs/blog/2024-11-15-zmk-studio-mvp-ga.mdx new file mode 100644 index 000000000000..0f0ea5cf56a8 --- /dev/null +++ b/docs/blog/2024-11-15-zmk-studio-mvp-ga.mdx @@ -0,0 +1,244 @@ +--- +title: "ZMK Studio MVP General Availability" +authors: petejohanson +tags: [firmware, studio, core] +--- + +import useBaseUrl from "@docusaurus/useBaseUrl"; +import ThemedImage from "@theme/ThemedImage"; + +import studioApp from "./assets/2024-11-15-zmk-studio-mvp-ga/zmk-studio-screenshot.png"; +import studioAppDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/zmk-studio-screenshot-dark-mode.png"; + +import niceAndTyperactive from "./assets/2024-11-15-zmk-studio-mvp-ga/niceandtyperactive.png"; +import niceAndTyperactiveDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/niceandtyperactive-dark-mode.png"; + +import kinesis from "./assets/2024-11-15-zmk-studio-mvp-ga/kinesis.png"; +import kinesisDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/kinesis-dark-mode.png"; + +import cannonKeys from "./assets/2024-11-15-zmk-studio-mvp-ga/cannonkeys.png"; +import cannonKeysDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/cannonkeys-dark-mode.png"; + +import keychron from "./assets/2024-11-15-zmk-studio-mvp-ga/keychron.png"; +import keychronDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/keychron-dark-mode.png"; + +import littleKeyboards from "./assets/2024-11-15-zmk-studio-mvp-ga/littlekeyboards.avif"; +import littleKeyboardsDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/littlekeyboards-dark-mode.avif"; + +import keebmaker from "./assets/2024-11-15-zmk-studio-mvp-ga/keebmaker.png"; +import keebmakerDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/keebmaker-dark-mode.png"; + +import keebio from "./assets/2024-11-15-zmk-studio-mvp-ga/keebio.avif"; +import keebioDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/keebio.avif"; + +import mode from "./assets/2024-11-15-zmk-studio-mvp-ga/mode.png"; +import modeDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/mode-dark-mode.png"; + +import phaseByte from "./assets/2024-11-15-zmk-studio-mvp-ga/phasebyte.png"; +import phaseByteDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/phasebyte.png"; + +import deskHero from "./assets/2024-11-15-zmk-studio-mvp-ga/deskhero.webp"; +import deskHeroDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/deskhero-dark-mode.webp"; + +import mechlovin from "./assets/2024-11-15-zmk-studio-mvp-ga/mechloving.png"; +import mechlovinDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/mechlovin-dark-mode.png"; + +import splitkb from "./assets/2024-11-15-zmk-studio-mvp-ga/splitkb.png"; +import splitkbDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/splitkb-dark-mode.png"; + +import keycapsss from "./assets/2024-11-15-zmk-studio-mvp-ga/keycapsss.png"; +import keycapsssDarkMode from "./assets/2024-11-15-zmk-studio-mvp-ga/keycapsss-dark-mode.png"; + +import mekibo from "./assets/2024-11-15-zmk-studio-mvp-ga/mekibo.png"; +import mekiboDarkMode from "./assets/2024-11-15-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. + + + +## 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](https://zmk.dev/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](https://zmk.dev/docs/features/studio#building) and [ZMK Studio keymap changes](https://zmk.dev/docs/features/studio#keymap-changes) for more details. + +See [Accessing ZMK Studio](https://zmk.dev/docs/features/studio#accessing-zmk-studio) for more details on the browser and desktop options for using the ZMK Studio application. + +## 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](https://zmk.dev/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-15-zmk-studio-mvp-ga/cannonkeys-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/cannonkeys-dark-mode.png new file mode 100644 index 000000000000..9de56abcd066 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/cannonkeys-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/cannonkeys.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/cannonkeys.png new file mode 100644 index 000000000000..55fc2fd9da70 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/cannonkeys.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/deskhero-dark-mode.webp b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/deskhero-dark-mode.webp new file mode 100644 index 000000000000..6601dcad515a Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/deskhero-dark-mode.webp differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/deskhero.webp b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/deskhero.webp new file mode 100644 index 000000000000..494bdbcd63b9 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/deskhero.webp differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keebio.avif b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keebio.avif new file mode 100644 index 000000000000..d7226dbac5ef Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keebio.avif differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keebmaker-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keebmaker-dark-mode.png new file mode 100644 index 000000000000..0667c1bcba12 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keebmaker-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keebmaker.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keebmaker.png new file mode 100644 index 000000000000..1d4561031e2b Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keebmaker.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keycapsss-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keycapsss-dark-mode.png new file mode 100644 index 000000000000..1dcd65bfb0bd Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keycapsss-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keycapsss.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keycapsss.png new file mode 100644 index 000000000000..e5e722eed782 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keycapsss.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keychron-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keychron-dark-mode.png new file mode 100644 index 000000000000..88ba0e5ef42f Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keychron-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keychron.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keychron.png new file mode 100644 index 000000000000..1ebef3817fe2 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/keychron.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/kinesis-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/kinesis-dark-mode.png new file mode 100644 index 000000000000..e211169b89cf Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/kinesis-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/kinesis.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/kinesis.png new file mode 100644 index 000000000000..7e77c3cc8786 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/kinesis.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/littlekeyboards-dark-mode.avif b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/littlekeyboards-dark-mode.avif new file mode 100644 index 000000000000..290e24c965cc Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/littlekeyboards-dark-mode.avif differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/littlekeyboards.avif b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/littlekeyboards.avif new file mode 100644 index 000000000000..172e2671fb92 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/littlekeyboards.avif differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mechlovin-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mechlovin-dark-mode.png new file mode 100644 index 000000000000..4f10bd1d87ab Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mechlovin-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mechloving.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mechloving.png new file mode 100644 index 000000000000..2a5b688457d6 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mechloving.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mekibo-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mekibo-dark-mode.png new file mode 100644 index 000000000000..1defeb2c40f7 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mekibo-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mekibo.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mekibo.png new file mode 100644 index 000000000000..dce43c7d5d9d Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mekibo.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mode-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mode-dark-mode.png new file mode 100644 index 000000000000..71b00a352384 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mode-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mode.png new file mode 100644 index 000000000000..662b8405b274 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/niceandtyperactive-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/niceandtyperactive-dark-mode.png new file mode 100644 index 000000000000..0ed8ffef8f68 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/niceandtyperactive-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/niceandtyperactive.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/niceandtyperactive.png new file mode 100644 index 000000000000..537e55978943 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/niceandtyperactive.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/phasebyte.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/phasebyte.png new file mode 100644 index 000000000000..d7c0df57a8d7 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/phasebyte.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/splitkb-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/splitkb-dark-mode.png new file mode 100644 index 000000000000..875a202aae8f Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/splitkb-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/splitkb.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/splitkb.png new file mode 100644 index 000000000000..eb0a4433f9a5 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/splitkb.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/zmk-studio-screenshot-dark-mode.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/zmk-studio-screenshot-dark-mode.png new file mode 100644 index 000000000000..e8d94ca13dc9 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/zmk-studio-screenshot-dark-mode.png differ diff --git a/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/zmk-studio-screenshot.png b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/zmk-studio-screenshot.png new file mode 100644 index 000000000000..dfc1057fdd22 Binary files /dev/null and b/docs/blog/assets/2024-11-15-zmk-studio-mvp-ga/zmk-studio-screenshot.png differ