Browse Source

refactor(docs): Move combos under Features.

* Since combos aren't a behavior, but a new high level keymap
  feature, move under Features section.
xmkb
Pete Johanson 4 years ago
parent
commit
e8aa576781
  1. 5
      docs/docs/features/combos.md
  2. 2
      docs/docs/intro.md
  3. 2
      docs/sidebars.js

5
docs/docs/behaviors/combos.md → docs/docs/features/combos.md

@ -1,6 +1,5 @@ @@ -1,6 +1,5 @@
---
title: Combo Behavior
sidebar_label: Combos
title: Combos
---
## Summary
@ -9,7 +8,7 @@ Combo keys are a way to combine multiple keypresses to output a different key. F @@ -9,7 +8,7 @@ Combo keys are a way to combine multiple keypresses to output a different key. F
### Configuration
Combos are specified like this:
Combos configured in your `.keymap` file, but are separate from the `keymap` node found there, since they are processed before the normal keymap. They are specified like this:
```
/ {

2
docs/docs/intro.md

@ -26,7 +26,7 @@ ZMK is currently missing some features found in other popular firmware. This tab @@ -26,7 +26,7 @@ ZMK is currently missing some features found in other popular firmware. This tab
| [Display Support](features/displays)[^2] | 🚧 | 🚧 | ✅ |
| [RGB Underglow](features/underglow) | ✅ | ✅ | ✅ |
| One Shot Keys | ✅ | ✅ | ✅ |
| [Combo Keys](behaviors/combos) | ✅ | | ✅ |
| [Combo Keys](features/combos) | ✅ | | ✅ |
| Macros | 🚧 | ✅ | ✅ |
| Mouse Keys | 💡 | ✅ | ✅ |
| Low Active Power Usage | ✅ | | |

2
docs/sidebars.js

@ -10,6 +10,7 @@ module.exports = { @@ -10,6 +10,7 @@ module.exports = {
],
Features: [
"features/keymaps",
"features/combos",
"features/displays",
"features/encoders",
"features/underglow",
@ -20,7 +21,6 @@ module.exports = { @@ -20,7 +21,6 @@ module.exports = {
"behaviors/misc",
"behaviors/hold-tap",
"behaviors/mod-tap",
"behaviors/combos",
"behaviors/reset",
"behaviors/bluetooth",
"behaviors/outputs",

Loading…
Cancel
Save