diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/blog/2020-09-21-zmk-sotf-2.md | 8 | ||||
| -rw-r--r-- | docs/blog/2020-11-09-zmk-sotf-3.md | 4 | ||||
| -rw-r--r-- | docs/docs/behaviors/bluetooth.md (renamed from docs/docs/behavior/bluetooth.md) | 0 | ||||
| -rw-r--r-- | docs/docs/behaviors/hold-tap.md (renamed from docs/docs/behavior/hold-tap.md) | 0 | ||||
| -rw-r--r-- | docs/docs/behaviors/key-press.md (renamed from docs/docs/behavior/key-press.md) | 0 | ||||
| -rw-r--r-- | docs/docs/behaviors/layers.md (renamed from docs/docs/behavior/layers.md) | 0 | ||||
| -rw-r--r-- | docs/docs/behaviors/lighting.md (renamed from docs/docs/behavior/lighting.md) | 0 | ||||
| -rw-r--r-- | docs/docs/behaviors/misc.md (renamed from docs/docs/behavior/misc.md) | 0 | ||||
| -rw-r--r-- | docs/docs/behaviors/mod-tap.md (renamed from docs/docs/behavior/mod-tap.md) | 0 | ||||
| -rw-r--r-- | docs/docs/behaviors/outputs.md (renamed from docs/docs/behavior/outputs.md) | 0 | ||||
| -rw-r--r-- | docs/docs/behaviors/power.md (renamed from docs/docs/behavior/power.md) | 0 | ||||
| -rw-r--r-- | docs/docs/behaviors/reset.md (renamed from docs/docs/behavior/reset.md) | 0 | ||||
| -rw-r--r-- | docs/docs/features/encoders.md | 2 | ||||
| -rw-r--r-- | docs/docs/features/keymaps.md | 4 | ||||
| -rw-r--r-- | docs/docs/intro.md | 52 | ||||
| -rw-r--r-- | docs/sidebars.js | 20 |
16 files changed, 45 insertions, 45 deletions
diff --git a/docs/blog/2020-09-21-zmk-sotf-2.md b/docs/blog/2020-09-21-zmk-sotf-2.md index 06c64f0..1ce61c9 100644 --- a/docs/blog/2020-09-21-zmk-sotf-2.md +++ b/docs/blog/2020-09-21-zmk-sotf-2.md @@ -16,16 +16,16 @@ Hacktoberfest activity, and a current open call for community feedback on a ZMK So much going on in ZMK! -- Added a new generic [Hold Tap behavior](https://zmkfirmware.dev/docs/behavior/hold-tap) +- Added a new generic [Hold Tap behavior](https://zmkfirmware.dev/docs/behaviors/hold-tap) in [#146](https://github.com/zmkfirmware/zmk/pull/146) which now powers mod-tap, layer-tap, etc. - [okke-formsma] -- [BLE profile/connection management](https://zmkfirmware.dev/docs/behavior/bluetooth) +- [BLE profile/connection management](https://zmkfirmware.dev/docs/behaviors/bluetooth) in [#133](https://github.com/zmkfirmware/zmk/pull/133) - [petejohanson] - Integration tests were added to automate testing of behaviors in [#131](https://github.com/zmkfirmware/zmk/pull/131) by [BrainWart] & [petejohanson] -- [Toggle layer behavior](https://zmkfirmware.dev/docs/behavior/layers#toggle-layer), e.g. `&tog LOWER`, in +- [Toggle layer behavior](https://zmkfirmware.dev/docs/behaviors/layers#toggle-layer), e.g. `&tog LOWER`, in [#98](https://github.com/zmkfirmware/zmk/pull/98) - [BrainWart] - Key fix for dropped press/release over HID [#93](https://github.com/zmkfirmware/zmk/pull/93)/[#96](https://github.com/zmkfirmware/zmk/pull/96) - [careyk007](https://github.com/careyk007) & [petejohanson] - Code formatting standardized using `clang-format` in [#183](https://github.com/zmkfirmware/zmk/pull/183) - [petejohanson] -- [Bootloader reset behavior](https://zmkfirmware.dev/docs/behavior/reset#bootloader-reset), e.g. `&bootloader`, in [#116](https://github.com/zmkfirmware/zmk/pull/116) - [petejohanson] +- [Bootloader reset behavior](https://zmkfirmware.dev/docs/behaviors/reset#bootloader-reset), e.g. `&bootloader`, in [#116](https://github.com/zmkfirmware/zmk/pull/116) - [petejohanson] - Various bug fixes and documentation ## New Shields diff --git a/docs/blog/2020-11-09-zmk-sotf-3.md b/docs/blog/2020-11-09-zmk-sotf-3.md index 8752065..9e250a9 100644 --- a/docs/blog/2020-11-09-zmk-sotf-3.md +++ b/docs/blog/2020-11-09-zmk-sotf-3.md @@ -67,7 +67,7 @@ With this change, you can add &ext_power EP_TOG ``` -to toggle (on/off) the power to external hardware like RGB underglow or OLEDs. Check out the [external power control](/docs/behavior/power#external-power-control) docs for more info. +to toggle (on/off) the power to external hardware like RGB underglow or OLEDs. Check out the [external power control](/docs/behaviors/power#external-power-control) docs for more info. #### Deep Sleep @@ -78,7 +78,7 @@ included some automatic power savings by switching to PORT events on the nRF52 c #### Output Selection -[joelspadin] added [output selection](/docs/behavior/outputs) to allow selecting whether to send output over USB or BLE if both are connected. This should now help avoid having "double keypresses" when your keyboard is plugged into a host. +[joelspadin] added [output selection](/docs/behaviors/outputs) to allow selecting whether to send output over USB or BLE if both are connected. This should now help avoid having "double keypresses" when your keyboard is plugged into a host. #### Bootloader Corruption Fix diff --git a/docs/docs/behavior/bluetooth.md b/docs/docs/behaviors/bluetooth.md index be0fb23..be0fb23 100644 --- a/docs/docs/behavior/bluetooth.md +++ b/docs/docs/behaviors/bluetooth.md diff --git a/docs/docs/behavior/hold-tap.md b/docs/docs/behaviors/hold-tap.md index 7ae5fc0..7ae5fc0 100644 --- a/docs/docs/behavior/hold-tap.md +++ b/docs/docs/behaviors/hold-tap.md diff --git a/docs/docs/behavior/key-press.md b/docs/docs/behaviors/key-press.md index dcf1a13..dcf1a13 100644 --- a/docs/docs/behavior/key-press.md +++ b/docs/docs/behaviors/key-press.md diff --git a/docs/docs/behavior/layers.md b/docs/docs/behaviors/layers.md index fcfdc93..fcfdc93 100644 --- a/docs/docs/behavior/layers.md +++ b/docs/docs/behaviors/layers.md diff --git a/docs/docs/behavior/lighting.md b/docs/docs/behaviors/lighting.md index 2d4f532..2d4f532 100644 --- a/docs/docs/behavior/lighting.md +++ b/docs/docs/behaviors/lighting.md diff --git a/docs/docs/behavior/misc.md b/docs/docs/behaviors/misc.md index 446ba33..446ba33 100644 --- a/docs/docs/behavior/misc.md +++ b/docs/docs/behaviors/misc.md diff --git a/docs/docs/behavior/mod-tap.md b/docs/docs/behaviors/mod-tap.md index da8b438..da8b438 100644 --- a/docs/docs/behavior/mod-tap.md +++ b/docs/docs/behaviors/mod-tap.md diff --git a/docs/docs/behavior/outputs.md b/docs/docs/behaviors/outputs.md index ae81249..ae81249 100644 --- a/docs/docs/behavior/outputs.md +++ b/docs/docs/behaviors/outputs.md diff --git a/docs/docs/behavior/power.md b/docs/docs/behaviors/power.md index 0de5055..0de5055 100644 --- a/docs/docs/behavior/power.md +++ b/docs/docs/behaviors/power.md diff --git a/docs/docs/behavior/reset.md b/docs/docs/behaviors/reset.md index 8cf122b..8cf122b 100644 --- a/docs/docs/behavior/reset.md +++ b/docs/docs/behaviors/reset.md diff --git a/docs/docs/features/encoders.md b/docs/docs/features/encoders.md index b78f89e..52a4357 100644 --- a/docs/docs/features/encoders.md +++ b/docs/docs/features/encoders.md @@ -25,7 +25,7 @@ Rotation is handled separately as a type of sensor. The behavior for this is set sensor-bindings = <BINDING CW_KEY CCW_KEY>; ``` -- `BINDING`, for now, has only one behavior available; `&inc_dec_kp` for key presses (see [Key Press](/docs/behavior/key-press) for details on available keycodes). +- `BINDING`, for now, has only one behavior available; `&inc_dec_kp` for key presses (see [Key Press](/docs/behaviors/key-press) for details on available keycodes). - `CW_KEY` is the keycode activated by a clockwise turn. - `CCW_KEY` is the keycode activated by a counter-clockwise turn. diff --git a/docs/docs/features/keymaps.md b/docs/docs/features/keymaps.md index c4c16c3..b5cae3c 100644 --- a/docs/docs/features/keymaps.md +++ b/docs/docs/features/keymaps.md @@ -30,7 +30,7 @@ For example, the simplest behavior in ZMK is the "key press" behavior, which res (a certain spot on the keyboard), and when that position is pressed, send a keycode to the host, and when the key position is released, updates the host to notify of the keycode being released. -For the full set of possible behaviors, start at the [Key Press](/docs/behavior/key-press) behavior. +For the full set of possible behaviors, start at the [Key Press](/docs/behaviors/key-press) behavior. ## Layers @@ -148,7 +148,7 @@ Each layer should have: 1. A `bindings` property this will be a list of behaviour bindings, one for each key position for the keyboard. 1. (Optional) A `sensor-bindings` property that will be a list of behavior bindings for each sensor on the keyboard. (Currently, only encoders are supported as sensor hardware, but in the future devices like trackpoints would be supported the same way) -For the full set of possible behaviors, start at the [Key Press](/docs/behavior/key-press) behavior. +For the full set of possible behaviors, start at the [Key Press](/docs/behaviors/key-press) behavior. ### Complete Example diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 55456d3..564eedb 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -11,32 +11,32 @@ firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK: -| **Feature** | ZMK | BlueMicro | QMK | -| ---------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: | -| Low Latency BLE Support | ✅ | ✅ | | -| Multi-Device BLE Support | ✅ | | | -| [USB Connectivity](behavior/outputs) | ✅ | | ✅ | -| User Configuration Repositories | ✅ | | | -| Split Keyboard Support | ✅ | ✅ | ✅ | -| [Keymaps and Layers](behavior/layers) | ✅ | ✅ | ✅ | -| [Hold-Tap](behavior/hold-tap) (which includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ | -| [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ | -| [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ | -| [Encoders](features/encoders)[^1] | ✅ | | ✅ | -| [OLED Display Support](features/displays)[^2] | 🚧 | 🚧 | ✅ | -| [RGB Underglow](features/underglow) | ✅ | ✅ | ✅ | -| One Shot Keys | 🚧 | ✅ | ✅ | -| Combo Keys | 🚧 | | ✅ | -| Macros | 🚧 | ✅ | ✅ | -| Mouse Keys | | ✅ | ✅ | -| Low Active Power Usage | ✅ | | | -| [Low Power Sleep States](https://github.com/zmkfirmware/zmk/pull/211) | 🚧 | ✅ | | -| [Low Power Mode (VCC Shutoff)](https://github.com/zmkfirmware/zmk/pull/242) | 🚧 | | | -| [Battery Reporting](https://github.com/zmkfirmware/zmk/issues/47) | 🚧 | ✅ | | -| Shell over BLE | | | | -| Realtime Keymap Updating | 💡 | | ✅ | -| AVR/8 Bit | | | ✅ | -| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | | +| **Feature** | ZMK | BlueMicro | QMK | +| ------------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: | +| Low Latency BLE Support | ✅ | ✅ | | +| Multi-Device BLE Support | ✅ | | | +| [USB Connectivity](behaviors/outputs) | ✅ | | ✅ | +| User Configuration Repositories | ✅ | | | +| Split Keyboard Support | ✅ | ✅ | ✅ | +| [Keymaps and Layers](behaviors/layers) | ✅ | ✅ | ✅ | +| [Hold-Tap](behaviors/hold-tap) (which includes [Mod-Tap](behaviors/mod-tap) and [Layer-Tap](behaviors/layers/#layer-tap)) | ✅ | ✅ | ✅ | +| [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ | +| [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ | +| [Encoders](features/encoders)[^1] | ✅ | | ✅ | +| [OLED Display Support](features/displays)[^2] | 🚧 | 🚧 | ✅ | +| [RGB Underglow](features/underglow) | ✅ | ✅ | ✅ | +| One Shot Keys | 🚧 | ✅ | ✅ | +| Combo Keys | 🚧 | | ✅ | +| Macros | 🚧 | ✅ | ✅ | +| Mouse Keys | | ✅ | ✅ | +| Low Active Power Usage | ✅ | | | +| [Low Power Sleep States](https://github.com/zmkfirmware/zmk/pull/211) | 🚧 | ✅ | | +| [Low Power Mode (VCC Shutoff)](https://github.com/zmkfirmware/zmk/pull/242) | 🚧 | | | +| [Battery Reporting](https://github.com/zmkfirmware/zmk/issues/47) | 🚧 | ✅ | | +| Shell over BLE | | | | +| Realtime Keymap Updating | 💡 | | ✅ | +| AVR/8 Bit | | | ✅ | +| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | | [^2]: Encoders are not currently supported on peripheral side splits. [^1]: OLEDs are currently proof of concept in ZMK. diff --git a/docs/sidebars.js b/docs/sidebars.js index d64d96c..9add949 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -15,16 +15,16 @@ module.exports = { "features/underglow", ], Behaviors: [ - "behavior/key-press", - "behavior/layers", - "behavior/misc", - "behavior/hold-tap", - "behavior/mod-tap", - "behavior/reset", - "behavior/bluetooth", - "behavior/outputs", - "behavior/lighting", - "behavior/power", + "behaviors/key-press", + "behaviors/layers", + "behaviors/misc", + "behaviors/hold-tap", + "behaviors/mod-tap", + "behaviors/reset", + "behaviors/bluetooth", + "behaviors/outputs", + "behaviors/lighting", + "behaviors/power", ], Codes: [ "codes/index", |