Skip to content

Commit

Permalink
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 13, 2024
1 parent a72327b commit 4ce77a6
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 @@ -14,6 +14,12 @@ ZMK Studio provides runtime update functionality to ZMK powered devices, allowin

To unlock your keyboard to allow ZMK Studio to make changes, you'll need to add a [`&studio_unlock`](../keymaps/behaviors/studio-unlock.md) binding to the keymap.

## Accessing ZMK Studio

You can use ZMK Studio with Chrome/Edge 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 4ce77a6

Please sign in to comment.