refactor(docs): Change feature
to features
Makes a better URL.
This commit is contained in:
parent
11a85f651a
commit
a685d88744
9 changed files with 12 additions and 12 deletions
|
@ -15,13 +15,13 @@ With interest and Discord activity growing, it seemed important to lay out the p
|
||||||
|
|
||||||
There's been lots of various activity in ZMK land!
|
There's been lots of various activity in ZMK land!
|
||||||
|
|
||||||
- [Nicell](https://github.com/Nicell) (nice!nano creator) contributed initial [RGB Underglow](/docs/feature/underglow) ([#64](https://github.com/zmkfirmware/zmk/pull/64)) support to ZMK.
|
- [Nicell](https://github.com/Nicell) (nice!nano creator) contributed initial [RGB Underglow](/docs/features/underglow) ([#64](https://github.com/zmkfirmware/zmk/pull/64)) support to ZMK.
|
||||||
- Tons of [documentation](/docs) work.
|
- Tons of [documentation](/docs) work.
|
||||||
- Refactoring ([#73](https://github.com/zmkfirmware/zmk/pull/73), [#74](https://github.com/zmkfirmware/zmk/pull/74)) of [keymaps](/docs/feature/keymaps) to make them simpler for users.
|
- Refactoring ([#73](https://github.com/zmkfirmware/zmk/pull/73), [#74](https://github.com/zmkfirmware/zmk/pull/74)) of [keymaps](/docs/features/keymaps) to make them simpler for users.
|
||||||
- Mod-Tap Behavior (docs coming!) is much improved ([#69](https://github.com/zmkfirmware/zmk/pull/69)) and usable now.
|
- Mod-Tap Behavior (docs coming!) is much improved ([#69](https://github.com/zmkfirmware/zmk/pull/69)) and usable now.
|
||||||
- An initial [`setup.sh`](http://localhost:3000/docs/user-setup#user-config-setup-script) script was created, allowing users to quickly bootstrap a "user config" setup and push it to GitHub, where GitHub Actions will build the firmware for you.
|
- An initial [`setup.sh`](http://localhost:3000/docs/user-setup#user-config-setup-script) script was created, allowing users to quickly bootstrap a "user config" setup and push it to GitHub, where GitHub Actions will build the firmware for you.
|
||||||
- Corne shield ([#80](https://github.com/zmkfirmware/zmk/pull/80)) shield definition was added.
|
- Corne shield ([#80](https://github.com/zmkfirmware/zmk/pull/80)) shield definition was added.
|
||||||
- Initial [encoder](/docs/feature/encoders) support ([#61](https://github.com/zmkfirmware/zmk/pull/61)) was added.
|
- Initial [encoder](/docs/features/encoders) support ([#61](https://github.com/zmkfirmware/zmk/pull/61)) was added.
|
||||||
|
|
||||||
## Bugs and Showstoppers
|
## Bugs and Showstoppers
|
||||||
|
|
||||||
|
|
|
@ -26,7 +26,7 @@ various config settings that can be commented/uncommented to modify how your fir
|
||||||
## Keymap
|
## Keymap
|
||||||
|
|
||||||
Once you have the basic user config completed, you can find the keymap file in `config/<shield>.keymap` and customize from there.
|
Once you have the basic user config completed, you can find the keymap file in `config/<shield>.keymap` and customize from there.
|
||||||
Refer to the [Keymap](/docs/feature/keymaps) documentation to learn more.
|
Refer to the [Keymap](/docs/features/keymaps) documentation to learn more.
|
||||||
|
|
||||||
## Publishing
|
## Publishing
|
||||||
|
|
||||||
|
|
|
@ -477,7 +477,7 @@ Add the following line to your keymap file to add default encoder behavior bindi
|
||||||
sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN>;
|
sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN>;
|
||||||
```
|
```
|
||||||
|
|
||||||
Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](/docs/feature/encoders) and [Keymap](/docs/feature/keymaps) feature documentation for more details.
|
Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](/docs/features/encoders) and [Keymap](/docs/features/keymaps) feature documentation for more details.
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
|
@ -22,9 +22,9 @@ ZMK is currently missing some features found in other popular firmware. This tab
|
||||||
| [Hold-Tap](behavior/hold-tap) (which includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ |
|
| [Hold-Tap](behavior/hold-tap) (which includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ |
|
||||||
| [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ |
|
| [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ |
|
||||||
| [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ |
|
| [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ |
|
||||||
| [Encoders](feature/encoders)[^1] | ✅ | | ✅ |
|
| [Encoders](features/encoders)[^1] | ✅ | | ✅ |
|
||||||
| [OLED Display Support](feature/displays)[^2] | 🚧 | 🚧 | ✅ |
|
| [OLED Display Support](features/displays)[^2] | 🚧 | 🚧 | ✅ |
|
||||||
| [RGB Underglow](feature/underglow) | ✅ | ✅ | ✅ |
|
| [RGB Underglow](features/underglow) | ✅ | ✅ | ✅ |
|
||||||
| One Shot Keys | 🚧 | ✅ | ✅ |
|
| One Shot Keys | 🚧 | ✅ | ✅ |
|
||||||
| Combo Keys | 🚧 | | ✅ |
|
| Combo Keys | 🚧 | | ✅ |
|
||||||
| Macros | 🚧 | ✅ | ✅ |
|
| Macros | 🚧 | ✅ | ✅ |
|
||||||
|
|
|
@ -9,10 +9,10 @@ module.exports = {
|
||||||
"troubleshooting",
|
"troubleshooting",
|
||||||
],
|
],
|
||||||
Features: [
|
Features: [
|
||||||
"feature/keymaps",
|
"features/keymaps",
|
||||||
"feature/displays",
|
"features/displays",
|
||||||
"feature/encoders",
|
"features/encoders",
|
||||||
"feature/underglow",
|
"features/underglow",
|
||||||
],
|
],
|
||||||
Behaviors: [
|
Behaviors: [
|
||||||
"behavior/key-press",
|
"behavior/key-press",
|
||||||
|
|
Loading…
Reference in a new issue