Merge branch 'main' into shift-registers

app/src/display/widgets/layer_status.c

@@ -24,13 +24,13 @@ struct layer_status_state {
 
 static void set_layer_symbol(lv_obj_t *label, struct layer_status_state state) {
     if (state.label == NULL) {
-        char text[7] = {};
+        char text[8] = {};
 
-        sprintf(text, LV_SYMBOL_KEYBOARD " %i", state.index);
+        snprintf(text, sizeof(text), LV_SYMBOL_KEYBOARD " %i", state.index);
 
         lv_label_set_text(label, text);
     } else {
-        char text[13] = {};
+        char text[14] = {};
 
         snprintf(text, sizeof(text), LV_SYMBOL_KEYBOARD " %s", state.label);
 

app/src/display/widgets/output_status.c

@@ -35,7 +35,7 @@ static struct output_status_state get_state(const zmk_event_t *_eh) {
 }
 
 static void set_status_symbol(lv_obj_t *label, struct output_status_state state) {
-    char text[10] = {};
+    char text[20] = {};
 
     switch (state.selected_endpoint.transport) {
     case ZMK_TRANSPORT_USB:

docs/blog/2020-05-24-wip.md

@@ -1,9 +1,6 @@
 ---
 title: WIP
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [keyboards, firmware, oss, ble]
 ---
 
@@ -11,3 +8,5 @@ This blog is a work-in-progress as I work on basic docs + blog on this nascent k
 
 As is, there are more features _missing_ from ZMK than features it has. As always with pre-alpha software,
 if something breaks, you get to keep both halves! (especially if it is a split KB)
+
+<!-- truncate -->

docs/blog/2020-08-12-zmk-sotf-1.md

@@ -1,9 +1,6 @@
 ---
 title: "ZMK State Of The Firmware #1"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [SOTF, keyboards, firmware, oss, ble]
 ---
 
@@ -11,6 +8,8 @@ Welcome to the first ZMK "State Of The Firmware"!
 
 With interest and Discord activity growing, it seemed important to lay out the progress made recently, current major bugs/showstoppers, and planned next steps.
 
+<!-- truncate -->
+
 ## Recent Activity
 
 There's been lots of various activity in ZMK land!

docs/blog/2020-09-21-zmk-sotf-2.md

@@ -1,9 +1,6 @@
 ---
 title: "ZMK State Of The Firmware #2"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [SOTF, keyboards, firmware, oss, ble]
 ---
 
@@ -12,6 +9,8 @@ Welcome to the second ZMK "State Of The Firmware" (SOTF)!
 This update will cover all the major activity since [SOTF #1](/blog/2020/08/12/zmk-sotf-1), preparations for the upcoming
 Hacktoberfest activity, and a current open call for community feedback on a ZMK mascot.
 
+<!-- truncate -->
+
 ## Recent Activity
 
 So much going on in ZMK!

docs/blog/2020-10-03-bootloader-fix.md

@@ -1,9 +1,6 @@
 ---
 title: Fixing the Mysterious Broken Bootloader
-author: Nick Winans
+authors: nickwinans
-author_title: Contributor
-author_url: https://github.com/Nicell
-author_image_url: https://avatars1.githubusercontent.com/u/9439650
 tags: [bootloader, keyboards, firmware, oss, ble]
 ---
 
@@ -12,6 +9,8 @@ Recently I was able to fix the "stuck in the bootloader" issue in
 for quite some time. I want to go over what the issue was, how the issue was
 diagnosed, and how it was fixed.
 
+<!-- truncate -->
+
 ## Background
 
 What exactly is the "stuck in the bootloader" issue? Seemingly randomly, users'

docs/blog/2020-11-09-zmk-sotf-3.md

@@ -1,9 +1,6 @@
 ---
 title: "ZMK State Of The Firmware #3"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [SOTF, keyboards, firmware, oss, ble]
 ---
 
@@ -11,6 +8,8 @@ Welcome to the third ZMK "State Of The Firmware" (SOTF)!
 
 This update will cover all the major activity since [SOTF #2](/blog/2020/09/21/zmk-sotf-2). This edition comes a bit later than planned, but the amount of features and changes will hopefully make it worth it!
 
+<!-- truncate -->
+
 ## Recent Activity
 
 Here's a summary of the various major changes since last time, broken down by theme:

docs/blog/2021-01-27-zmk-sotf-4.md

@@ -1,9 +1,6 @@
 ---
 title: "ZMK State Of The Firmware #4"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [SOTF, keyboards, firmware, oss, ble]
 ---
 
@@ -11,6 +8,8 @@ Welcome to the fourth ZMK "State Of The Firmware" (SOTF)!
 
 This update will cover all the major activity since [SOTF #3](/blog/2020/11/09/zmk-sotf-3).
 
+<!-- truncate -->
+
 ## Recent Activity
 
 Here's a summary of the various major changes since last time, broken down by theme:

docs/blog/2021-07-17-zephyr-2-5.md

@@ -1,14 +1,13 @@
 ---
 title: "Zephyr 2.5 Update"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [firmware, zephyr, core]
 ---
 
 I'm happy to announce that we have completed the [work](https://github.com/zmkfirmware/zmk/pull/736/) to upgrade ZMK to [Zephyr 2.5](https://docs.zephyrproject.org/2.5.0/releases/release-notes-2.5.html)!
 
+<!-- truncate -->
+
 A big part of this work was some _major_ refactors and improvements by [innovaker] to our [zmk-docker](https://github.com/zmkfirmware/zmk-docker/) Docker image and GH Actions automation.
 
 - Faster build times with improved caching.

docs/blog/2022-03-08-zephyr-3-0-upgrade-prep.md

@@ -1,15 +1,14 @@
 ---
 title: "Zephyr 3.0 Update Preparation"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [firmware, zephyr, core]
 ---
 
 As preparation for completing the [work](https://github.com/zmkfirmware/zmk/pull/1143) to upgrade ZMK to [Zephyr 3.0](https://docs.zephyrproject.org/3.0.0/releases/release-notes-3.0.html), users with user config repositories who wish to avoid future build failures with their GitHub Actions workflows can take steps to adjust
 their repositories now.
 
+<!-- truncate -->
+
 GitHub Actions needs to use our latest Docker image to ensure continued compatibility with the ZMK codebase on Zephyr 3.0 (and beyond). You should:
 
 - Open `.github/workflows/build.yml` in your editor/IDE

docs/blog/2022-04-02-zephyr-3-0.md

@@ -1,14 +1,13 @@
 ---
 title: "Zephyr 3.0 Update"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [firmware, zephyr, core]
 ---
 
 I'm happy to announce that we have completed the [work](https://github.com/zmkfirmware/zmk/pull/1143) to upgrade ZMK to [Zephyr 3.0](https://docs.zephyrproject.org/3.0.0/releases/release-notes-3.0.html)!
 
+<!-- truncate -->
+
 [petejohanson] did the upgrade work to adjust ZMK for the Zephyr changes.
 
 - Moving to Zephyr's UF2 build integration that was submitted upstream by [petejohanson]

docs/blog/2022-04-10-zmk-sotf-5.md

@@ -1,9 +1,6 @@
 ---
 title: "ZMK State Of The Firmware #5"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [SOTF, keyboards, firmware, oss, ble]
 ---
 
@@ -11,6 +8,8 @@ Welcome to the fifth ZMK "State Of The Firmware" (SOTF)!
 
 This update will cover all the major activity since [SOTF #4](/blog/2021/01/27/zmk-sotf-4). That was over a year ago, so lots to cover!
 
+<!-- truncate -->
+
 ## Recent Activity
 
 Here's a summary of the various major changes since last time, broken down by theme:

docs/blog/2022-04-21-zmk-2yo.md

@@ -1,14 +1,13 @@
 ---
 title: "ZMK's Second Birthday"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [keyboards, firmware, oss]
 ---
 
 Two years ago, today, I minted the first ever commit for ZMK:
 
+<!-- truncate -->
+
 ```
 commit 85c8be89dea8f7a00e8efb06d38e2b32f3459935
 Author: Pete Johanson <peter@peterjohanson.com>

docs/blog/2023-04-06-zephyr-3-2.md

@@ -1,14 +1,13 @@
 ---
 title: "Zephyr 3.2 Update"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [firmware, zephyr, core]
 ---
 
 I'm happy to announce that we have completed the [work](https://github.com/zmkfirmware/zmk/pull/1499) to upgrade ZMK to [Zephyr 3.2](https://docs.zephyrproject.org/3.2.0/releases/release-notes-3.2.html)!
 
+<!-- truncate -->
+
 [petejohanson] did the upgrade work to adjust ZMK for the Zephyr changes, with help from [Nicell] on the LVGL pieces.
 
 - Upgrade to LVGL 8.x API, and move to the new Kconfig settings.

docs/blog/2023-06-18-encoder-refactors.md

@@ -1,9 +1,6 @@
 ---
 title: "Major Encoder Refactor"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [firmware, zephyr, sensors, encoders]
 ---
 
@@ -11,6 +8,8 @@ Today, we merged a significant change to the low level sensor code that is used
 this paves the way for completing the work on supporting split peripheral sensors/encoders, and other future sensors
 like pointing devices.
 
+<!-- truncate -->
+
 As part of the work, backwards compatibility for existing shields has been retained, but only for a grace period to allow out-of-tree shields to move to the new approach for encoders.
 
 Special thanks to [joelspadin] for the _thorough_ code review and testing throughout the development of the refactor.

docs/blog/2023-10-05-zmk-sotf-6.md

@@ -1,9 +1,6 @@
 ---
 title: "ZMK State Of The Firmware #6"
-author: Cem Aksoylar
+authors: caksoylar
-author_title: Documentation maintainer
-author_url: https://github.com/caksoylar
-author_image_url: https://avatars.githubusercontent.com/u/7876996
 tags: [SOTF, keyboards, firmware, oss, ble]
 ---
 
@@ -11,6 +8,8 @@ Welcome to the sixth ZMK "State Of The Firmware" (SOTF)!
 
 This update will cover all the major activity since [SOTF #5](/blog/2022/04/10/zmk-sotf-5). That was over a year ago (again!), so there are many new exciting features and plenty of improvements to cover!
 
+<!-- truncate -->
+
 ## Recent Activity
 
 Here's a summary of the various major changes since last time, broken down by theme:

docs/blog/2023-11-09-keymap-editor.mdx

@@ -1,14 +1,15 @@
 ---
 title: "Community Spotlight Series #1: Keymap Editor"
-author: Cem Aksoylar
+authors: caksoylar
-author_title: Documentation maintainer
-author_url: https://github.com/caksoylar
-author_image_url: https://avatars.githubusercontent.com/u/7876996
 tags: [keyboards, firmware, community]
 ---
 
 import ThemedImage from "@theme/ThemedImage";
 
+This blog post is the first in a series of posts where we highlight projects within the ZMK ecosystem that we think are cool and that the users might benefit from knowing about them. We are starting the series with a big one, [Keymap Editor](http://nickcoutsos.github.io/keymap-editor) by [Nick Coutsos](https://github.com/nickcoutsos)!
+
+{/* truncate */}
+
 <ThemedImage
   alt="Shows a screenshot of the Keymap Editor application featuring a graphical layout of the Corne Keyboard with a keymap loaded from the nickcoutsos/keymap-editor-demo-crkbd GitHub repository."
   sources={{
@@ -20,8 +21,6 @@ import ThemedImage from "@theme/ThemedImage";
   }}
 />
 
-This blog post is the first in a series of posts where we highlight projects within the ZMK ecosystem that we think are cool and that the users might benefit from knowing about them. We are starting the series with a big one, [Keymap Editor] by [Nick Coutsos](https://github.com/nickcoutsos)!
-
 In the rest of the post we leave it to Nick himself to introduce the project, detail his goals and motivation in developing such a tool, and talk about the future of the project. Stay tuned for future installments in the series!
 
 ## What is Keymap Editor?

docs/blog/2023-12-17-nodefree-config.md

@@ -1,9 +1,6 @@
 ---
 title: "Community Spotlight Series #2: Node-free Config"
-author: Cem Aksoylar
+authors: caksoylar
-author_title: Documentation maintainer
-author_url: https://github.com/caksoylar
-author_image_url: https://avatars.githubusercontent.com/u/7876996
 tags: [keyboards, firmware, community]
 ---
 
@@ -17,6 +14,8 @@ by [urob](https://github.com/urob) that contains helper methods that utilizes th
 for users who prefer editing and maintaining their ZMK config directly using the Devicetree
 syntax format.
 
+<!-- truncate -->
+
 In the rest of the post we leave it to urob to introduce and explain the motivations of the
 project, and various ways it can be used to help maintain ZMK keymaps. Stay tuned for future
 installments in the series!

docs/blog/2024-01-05-zmk-tools.md

@@ -1,9 +1,6 @@
 ---
 title: "Community Spotlight Series #3: ZMK Tools and ZMK Locale Generator"
-author: Cem Aksoylar
+authors: caksoylar
-author_title: Documentation maintainer
-author_url: https://github.com/caksoylar
-author_image_url: https://avatars.githubusercontent.com/u/7876996
 tags: [keyboards, firmware, community]
 ---
 
@@ -12,6 +9,9 @@ that we think are interesting and that the users might benefit from knowing abou
 
 In this installment, we are highlighting two projects (and a bonus one!) from [Joel Spadin](https://github.com/joelspadin),
 a member of the core ZMK team.
+
+<!-- truncate -->
+
 The first one is [ZMK Tools](#zmk-tools), a handy Visual Studio Code extension to ease working with ZMK configurations, and the second is [ZMK Locale Generator](#zmk-locale-generator), a tool to help users that use non-US English keyboard locales in their operating systems.
 
 In the rest of the post we leave it to Joel to introduce and explain the motivations of his ZMK-related projects.

docs/blog/2024-02-09-zephyr-3-5.md

@@ -1,14 +1,13 @@
 ---
 title: "Zephyr 3.5 Update"
-author: Pete Johanson
+authors: petejohanson
-author_title: Project Creator
-author_url: https://gitlab.com/petejohanson
-author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
 tags: [firmware, zephyr, core]
 ---
 
 I'm happy to announce that we have completed the [work](https://github.com/zmkfirmware/zmk/pull/1995) to upgrade ZMK to [Zephyr 3.5](https://docs.zephyrproject.org/3.5.0/releases/release-notes-3.5.html)!
 
+<!-- truncate -->
+
 [petejohanson] did the upgrade work to adjust ZMK for the Zephyr changes:
 
 - Add `west flash` support to all UF2 capable boards.

docs/blog/authors.yml

@@ -0,0 +1,17 @@
+petejohanson:
+  name: Pete Johanson
+  title: Project Creator
+  url: https://gitlab.com/petejohanson
+  image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
+
+nickwinans:
+  name: Nick Winans
+  title: Contributor
+  url: https://github.com/Nicell
+  image_url: https://avatars1.githubusercontent.com/u/9439650
+
+caksoylar:
+  name: Cem Aksoylar
+  title: Documentation maintainer
+  url: https://github.com/caksoylar
+  image_url: https://avatars.githubusercontent.com/u/7876996

docs/docs/development/hardware-integration/new-shield.mdx

@@ -254,12 +254,12 @@ RC(3,0) RC(3,1) RC(3,2) RC(3,3) RC(3,4) RC(3,5) RC(4,2) RC(4,9) RC(3,6) RC(3,7)
 ```
 
 :::note
-Notice that in addition to the common `row-gpios` that are declared in the kscan, the [matrix transform](#optional-matrix-transform) is defined in the .dtsi.
+Notice that in addition to the common `row-gpios` that are declared in the kscan, the [matrix transform](#matrix-transform) is defined in the .dtsi.
 :::
 
 The missing `col-gpios` would be defined in your `<boardname>_left.overlay` and `<boardname>_right.overlay` files.
 Keep in mind that the mirrored position of the GPIOs means that the `col-gpios` will appear reversed when the .overlay files are compared to one another.
-Furthermore, the column offset for the [matrix transform](#optional-matrix-transform) should be added to the right half of the keyboard's overlay
+Furthermore, the column offset for the [matrix transform](#matrix-transform) should be added to the right half of the keyboard's overlay
 because the keyboard's switch matrix is read from left to right, top to bottom.
 This is exemplified with the iris .overlay files.
 

docs/docs/faq.md

@@ -57,7 +57,7 @@ For keyboards, this is one of two options:
 
 ### What is a “shield”?
 
-In ZMK, a _shield_ is a _PCB_ or _hardwired set of components_ that when combined with a MCU only [board](#what-is-a-board) like the Proton-C or nice!nano, results in a complete usable keyboard. Examples would be keyboard PCBs like the Kyria or Corne. The _shield_ is usually the big PCB containing all the keys.
+In ZMK, a _shield_ is a _PCB_ or _hardwired set of components_ that when combined with an MCU-only [board](#what-is-a-board), like the Proton-C or nice!nano, results in a complete usable keyboard. Examples would be keyboard PCBs like the Kyria or Lily58. The _shield_ is usually the big PCB containing all the keys.
 
 ### Why _boards_ and _shields_? Why not just “keyboard”?
 

docs/docs/features/modules.mdx

@@ -149,7 +149,7 @@ When [using GitHub Actions to build ZMK](../user-setup.mdx), once you have obtai
 defaultValue="zmk"
 values={[
 {label: 'Default', value: 'zmk'},
-{label: 'Alterative', value: 'alt'},
+{label: 'Alternative', value: 'alt'},
 ]}>
 <TabItem value="zmk">
 

docs/docs/features/split-keyboards.md

@@ -55,7 +55,7 @@ Any changes in ZMK related to split keyboard features might also necessitate doi
 
 Split keyboards with BLE-based split communications (i.e. all officially supported split keyboards) have an internal pairing procedure between the central and each peripheral.
 When the central has an open slot for a peripheral, it will advertise for connections (which will not be visible to non-ZMK devices).
-Then, any peripheral that has not yet bonded to a peripheral will pair to it.
+Then, any peripheral that has not yet bonded to a central will pair to it.
 Similar to how [bluetooth profiles](bluetooth.md) are managed between the keyboard and host devices, the bonding information will be stored with the corresponding hardware addresses of the other keyboard part, on both the central and peripheral.
 
 In practice, this means that your split keyboard parts will automatically pair and work the first time they are all on at the same time.

docs/docs/keymaps/behaviors/tap-dance.mdx

@@ -20,7 +20,7 @@ Defines the maximum elapsed time after the last tap-dance keybind press before a
 
 #### `bindings`
 
-An array of one or more keybinds. This list can include [any ZMK keycode](../list-of-keycodes.mdx) and any listed ZMK behavior, like [hold-taps](hold-tap.mdx), or [sticky keys](sticky-key.md). The index of a keybind in the `bindings` array corresponds to the number of times the tap-dance binding is pressed. For example, in the [basic tap-dance counter](#basic-example-counter) shown below, `&kp N2` is the second binding in the array of `bindings`: we then see an output of `2` when the `td0` binding is pressed twice.
+An array of one or more keybinds. This list can include [any ZMK keycode](../list-of-keycodes.mdx) and any listed ZMK behavior, like [hold-taps](hold-tap.mdx), or [sticky keys](sticky-key.md). The index of a keybind in the `bindings` array corresponds to the number of times the tap-dance binding is pressed. For example, in the basic tap-dance counter shown below, `&kp N2` is the second binding in the array of `bindings`: we then see an output of `2` when the `td0` binding is pressed twice.
 
 The number of bindings in this array also determines the tap-dance's maximum number of keypresses. When a tap-dance reaches its maximum number of keypresses, it will immediately invoke the last behavior in its list of `bindings`, rather than waiting for [`tapping-term-ms`](#tapping-term-ms) to expire before the output is displayed.
 

docs/docusaurus.config.js

@@ -165,6 +165,7 @@ module.exports = {
     ],
   ],
   markdown: {
+    format: "detect",
     mermaid: true,
     mdx1Compat: {
       comments: false,

docs/package.json

@@ -29,7 +29,7 @@
     "react-copy-to-clipboard": "^5.0.3",
     "react-dom": "^18.0.0",
     "react-toastify": "^10.0.5",
-    "web-tree-sitter": "^0.20.8"
+    "web-tree-sitter": "^0.23.0"
   },
   "browserslist": {
     "production": [
@@ -62,6 +62,6 @@
     "prettier": "^2.8.7",
     "string-replace-loader": "^3.1.0",
     "typescript": "^5.0.4",
-    "webpack": "^5.86.0"
+    "webpack": "^5.94.0"
   }
 }