From e8aa576781532e883308bf2aec3a77f68ae3f545 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Sat, 23 Jan 2021 23:50:30 -0500 Subject: [PATCH] refactor(docs): Move combos under Features. * Since combos aren't a behavior, but a new high level keymap feature, move under Features section. --- docs/docs/{behaviors => features}/combos.md | 5 ++--- docs/docs/intro.md | 2 +- docs/sidebars.js | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) rename docs/docs/{behaviors => features}/combos.md (92%) diff --git a/docs/docs/behaviors/combos.md b/docs/docs/features/combos.md similarity index 92% rename from docs/docs/behaviors/combos.md rename to docs/docs/features/combos.md index e9b01761..845bb018 100644 --- a/docs/docs/behaviors/combos.md +++ b/docs/docs/features/combos.md @@ -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 ### 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: ``` / { diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 2215291c..45aadfdd 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -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 | ✅ | | | diff --git a/docs/sidebars.js b/docs/sidebars.js index d095a47e..56de3eb8 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -10,6 +10,7 @@ module.exports = { ], Features: [ "features/keymaps", + "features/combos", "features/displays", "features/encoders", "features/underglow", @@ -20,7 +21,6 @@ module.exports = { "behaviors/misc", "behaviors/hold-tap", "behaviors/mod-tap", - "behaviors/combos", "behaviors/reset", "behaviors/bluetooth", "behaviors/outputs",