Skip to content

Commit

Permalink
feat(docs): Add ZMK Studio links.
Browse files Browse the repository at this point in the history
* Add a toplevel ZMK Studio link in our header.
* Add link to the web and app releases to the feature page.
  • Loading branch information
petejohanson committed Oct 10, 2024
1 parent d3f2895 commit d8b7cef
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/docs/features/studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ ZMK Studio support is in alpha. Although best efforts are being made, keeping co

ZMK Studio provides runtime update functionality to ZMK powered devices, allowing users to change their keymap layers without flashing new firmware to their keyboards. Studio is still under active development, and is not yet ready for casual end user use.

## Accessing ZMK Studio

If using Chrome/Edge, you can use ZMK Studio directly from your browser at https://zmk.studio/

To use the native app for Linux, macOS, or Windows, download the appropriate file from the [latest release](https://github.com/zmkfirmware/zmk-studio/releases)

## Building

Building for ZMK Studio involves two main additional items.
Expand Down
5 changes: 5 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ module.exports = {
label: "Keymap Upgrader",
position: "left",
},
{
href: "https://zmk.studio/",
label: "ZMK Studio",
position: "right",
},
{
href: "https://github.com/zmkfirmware/zmk",
label: "GitHub",
Expand Down

0 comments on commit d8b7cef

Please sign in to comment.