Skip to content

Commit 8aa0cee

Browse files
minusfiveminusfive
authored
docs(README): document implicit hyper key (#39)
1 parent c7a83f6 commit 8aa0cee

File tree

7 files changed

+170
-18
lines changed

7 files changed

+170
-18
lines changed

‎.github/workflows/draw.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,14 @@ concurrency:
1717

1818
jobs:
1919
draw:
20-
uses: caksoylar/keymap-drawer/.github/workflows/draw-zmk.yml@main
20+
uses: caksoylar/keymap-drawer/.github/workflows/draw-zmk.yml@dev
2121
permissions:
2222
contents: write
2323
with:
24-
install_branch: "main" # branch to install keymap-drawer from
24+
install_branch: "dev" # branch to install keymap-drawer from
2525
keymap_patterns: "config/corneish_zen.keymap" # path to the keymaps to parse
2626
config_path: "keymap-drawer/config.yaml" # config file, ignored if it doesn't exist
2727
output_folder: "img" # path to save produced SVGs
28+
extra_keymap_yaml: "corneish_zen:'keymap-drawer/combos.yaml'"
2829
commit_message: "chore(draw): keymap"
2930
fail_on_error: true

‎README.md‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,20 @@ Knucklehead[^1] is a mnemonic, macOS-optimized, 42 key ergonomic columnar layout
1818
1919
## Legend
2020

21-
| Symbol | Key Name | Symbol | Key Name |
22-
| :----: | -------------------------------------------- | :----: | --------------------------------------------------------- |
23-
| 🆆 | [Smart 🆆ord behavior](#smart-🆆ord-behaviors) | 🆇 | [E🆇it smart 🆆ord behavior](#e🆇iting-smart-🆆ord-behaviors) |
24-
| ⌃ | Control | ⇥ | Tab |
25-
| ⌥ | Option | ␣ | Space |
26-
| ⌘ | Command | ⇡ | Page Up |
27-
| ▲ | Meh (⌃ + ⌥ + ⇧) | ⇣ | Page Down |
28-
| ⇧ | Shift | ⛭ | Brightness Up |
29-
| ⇪ | Caps Lock | ⛯ | Brightness Down |
30-
| ⌫ | Backspace | ⟲ | Firmware reset (hold: bootloader mode) |
31-
| ⌦ | Delete | `L1` | Layer 1 |
32-
| ⏎ | Return | `L2` | Layer 2 |
33-
| ⏻ | Power | `Fn` | Function Layer |
21+
| Symbol | Key Name | Symbol | Key Name |
22+
| :----: | --------------------------------------------------- | :----: | --------------------------------------------------------- |
23+
| 🆆 | [Smart 🆆ord behavior](#smart-🆆ord-behaviors) | 🆇 | [E🆇it smart 🆆ord behavior](#e🆇iting-smart-🆆ord-behaviors) |
24+
| ⌃ | Control | ⇥ | Tab |
25+
| ⌥ | Option | ␣ | Space |
26+
| ⌘ | Command | ⇡ | Page Up |
27+
| ▲ | Meh (⌃ + ⌥ + ⇧) | ⇣ | Page Down |
28+
| ✦ | Hyper (⌃ + ⌥ + ⌘ + ⇧) | ⛭ | Brightness Up |
29+
| ⇧ | Shift | ⛯ | Brightness Down |
30+
| ⇪ | Caps Lock | ⟲ | Firmware reset (hold: bootloader mode) |
31+
| ⌫ | Backspace | | |
32+
| ⌦ | Delete | `L1` | Layer 1 |
33+
| ⏎ | Return | `L2` | Layer 2 |
34+
| ⏻ | Power | `Fn` | Function Layer |
3435

3536
## Features
3637

‎img/corneish_zen.svg‎

Lines changed: 84 additions & 0 deletions
Loading

‎keymap-drawer/combos.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
combos:
2+
- p: [16, 17]
3+
k: { t: $$mdi:star-four-points$$ }
4+
l: [L1, L2, Fn]
5+
- p: [18, 19]
6+
k: { t: $$mdi:star-four-points$$ }
7+
l: [L1, L2, Fn]

‎keymap-drawer/config.yaml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -725,3 +725,60 @@ draw_config:
725725
--color--key--bg: var(--color--material--teal--200);
726726
--color--key--border: var(--color--material--teal--100);
727727
}
728+
729+
.combo.tap.glyph {
730+
scale: 0.8;
731+
}
732+
733+
.layer-L1 .combopos-19 .tap.glyph,
734+
.layer-L2 .combopos-19 .tap.glyph,
735+
.layer-Fn .combopos-15 .tap.glyph {
736+
transform-origin-x: 400px;
737+
}
738+
739+
.layer-L1 .combopos-18 .tap.glyph,
740+
.layer-L1 .combopos-20 .tap.glyph,
741+
.layer-L2 .combopos-18 .tap.glyph,
742+
.layer-L2 .combopos-20 .tap.glyph,
743+
.layer-Fn .combopos-14 .tap.glyph,
744+
.layer-Fn .combopos-16 .tap.glyph {
745+
transform-origin-x: 802px;
746+
}
747+
748+
.layer-L1 .combopos-13 .tap.glyph,
749+
.layer-L1 .combopos-14 .tap.glyph,
750+
.layer-L2 .combopos-13 .tap.glyph,
751+
.layer-L2 .combopos-14 .tap.glyph,
752+
.layer-Fn .combopos-3 .tap.glyph,
753+
.layer-Fn .combopos-4 .tap.glyph {
754+
transform-origin-x: 762px;
755+
}
756+
757+
758+
.layer-L1 .combopos-13 .tap.glyph,
759+
.layer-L2 .combopos-13 .tap.glyph,
760+
.layer-Fn .combopos-3 .tap.glyph {
761+
transform-origin-y: 97px;
762+
}
763+
764+
.layer-L1 .combopos-14 .tap.glyph,
765+
.layer-L2 .combopos-14 .tap.glyph,
766+
.layer-Fn .combopos-4 .tap.glyph {
767+
transform-origin-y: 177px;
768+
}
769+
770+
771+
.layer-L1 .combopos-18 .tap.glyph,
772+
.layer-L2 .combopos-18 .tap.glyph,
773+
.layer-Fn .combopos-14 .tap.glyph {
774+
transform-origin-y: 52px;
775+
}
776+
777+
.layer-L1 .combopos-19 .tap.glyph,
778+
.layer-L2 .combopos-19 .tap.glyph,
779+
.layer-Fn .combopos-15 .tap.glyph,
780+
.layer-L1 .combopos-20 .tap.glyph,
781+
.layer-L2 .combopos-20 .tap.glyph,
782+
.layer-Fn .combopos-16 .tap.glyph {
783+
transform-origin-y: 132px;
784+
}

‎mise.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
[tools]
2-
"pipx:keymap-drawer" = "latest"
2+
# "pipx:keymap-drawer" = "latest"
3+
"pipx:caksoylar/keymap-drawer" = "dev"

‎scripts/draw.zsh‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ function {
99
local __keymap_input_file="$__repo_dir/config/${__keymap}.keymap"
1010
local __keymap_svg="$__repo_dir/img/${__keymap}.svg"
1111
local __keymap_yaml="$__repo_dir/img/${__keymap}.yaml"
12+
local __combos_yaml="$__repo_dir/keymap-drawer/combos.yaml"
1213
local __draw_config="$__repo_dir/keymap-drawer/config.yaml"
1314

14-
keymap -c $__draw_config parse -z $__keymap_input_file -o $__keymap_yaml
15-
keymap -c $__draw_config draw $__keymap_yaml -o $__keymap_svg
15+
keymap -c $__draw_config parse -z $__keymap_input_file > $__keymap_yaml
16+
keymap -c $__draw_config draw $__keymap_yaml $__combos_yaml > $__keymap_svg
1617
} $@
1718

0 commit comments

Comments
 (0)