Skip to content

docs: document implicit hyper key #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 22, 2025
Merged

docs: document implicit hyper key #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
999bb87
docs: document implicit hyper key
minusfive Mar 22, 2025
b567a1e
docs(README): add hyper to legend
minusfive Mar 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/draw.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@ concurrency:

jobs:
draw:
uses: caksoylar/keymap-drawer/.github/workflows/draw-zmk.yml@main
uses: caksoylar/keymap-drawer/.github/workflows/draw-zmk.yml@dev
permissions:
contents: write
with:
install_branch: "main" # branch to install keymap-drawer from
install_branch: "dev" # branch to install keymap-drawer from
keymap_patterns: "config/corneish_zen.keymap" # path to the keymaps to parse
config_path: "keymap-drawer/config.yaml" # config file, ignored if it doesn't exist
output_folder: "img" # path to save produced SVGs
extra_keymap_yaml: "corneish_zen:'keymap-drawer/combos.yaml'"
commit_message: "chore(draw): keymap"
fail_on_error: true
27 changes: 14 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,20 @@ Knucklehead[^1] is a mnemonic, macOS-optimized, 42 key ergonomic columnar layout

## Legend

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

## Features

Expand Down
84 changes: 84 additions & 0 deletions img/corneish_zen.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions keymap-drawer/combos.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
combos:
- p: [16, 17]
k: { t: $$mdi:star-four-points$$ }
l: [L1, L2, Fn]
- p: [18, 19]
k: { t: $$mdi:star-four-points$$ }
l: [L1, L2, Fn]
57 changes: 57 additions & 0 deletions keymap-drawer/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,3 +725,60 @@ draw_config:
--color--key--bg: var(--color--material--teal--200);
--color--key--border: var(--color--material--teal--100);
}

.combo.tap.glyph {
scale: 0.8;
}

.layer-L1 .combopos-19 .tap.glyph,
.layer-L2 .combopos-19 .tap.glyph,
.layer-Fn .combopos-15 .tap.glyph {
transform-origin-x: 400px;
}

.layer-L1 .combopos-18 .tap.glyph,
.layer-L1 .combopos-20 .tap.glyph,
.layer-L2 .combopos-18 .tap.glyph,
.layer-L2 .combopos-20 .tap.glyph,
.layer-Fn .combopos-14 .tap.glyph,
.layer-Fn .combopos-16 .tap.glyph {
transform-origin-x: 802px;
}

.layer-L1 .combopos-13 .tap.glyph,
.layer-L1 .combopos-14 .tap.glyph,
.layer-L2 .combopos-13 .tap.glyph,
.layer-L2 .combopos-14 .tap.glyph,
.layer-Fn .combopos-3 .tap.glyph,
.layer-Fn .combopos-4 .tap.glyph {
transform-origin-x: 762px;
}


.layer-L1 .combopos-13 .tap.glyph,
.layer-L2 .combopos-13 .tap.glyph,
.layer-Fn .combopos-3 .tap.glyph {
transform-origin-y: 97px;
}

.layer-L1 .combopos-14 .tap.glyph,
.layer-L2 .combopos-14 .tap.glyph,
.layer-Fn .combopos-4 .tap.glyph {
transform-origin-y: 177px;
}


.layer-L1 .combopos-18 .tap.glyph,
.layer-L2 .combopos-18 .tap.glyph,
.layer-Fn .combopos-14 .tap.glyph {
transform-origin-y: 52px;
}

.layer-L1 .combopos-19 .tap.glyph,
.layer-L2 .combopos-19 .tap.glyph,
.layer-Fn .combopos-15 .tap.glyph,
.layer-L1 .combopos-20 .tap.glyph,
.layer-L2 .combopos-20 .tap.glyph,
.layer-Fn .combopos-16 .tap.glyph {
transform-origin-y: 132px;
}
3 changes: 2 additions & 1 deletion mise.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
[tools]
"pipx:keymap-drawer" = "latest"
# "pipx:keymap-drawer" = "latest"
"pipx:caksoylar/keymap-drawer" = "dev"
5 changes: 3 additions & 2 deletions scripts/draw.zsh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ function {
local __keymap_input_file="$__repo_dir/config/${__keymap}.keymap"
local __keymap_svg="$__repo_dir/img/${__keymap}.svg"
local __keymap_yaml="$__repo_dir/img/${__keymap}.yaml"
local __combos_yaml="$__repo_dir/keymap-drawer/combos.yaml"
local __draw_config="$__repo_dir/keymap-drawer/config.yaml"

keymap -c $__draw_config parse -z $__keymap_input_file -o $__keymap_yaml
keymap -c $__draw_config draw $__keymap_yaml -o $__keymap_svg
keymap -c $__draw_config parse -z $__keymap_input_file > $__keymap_yaml
keymap -c $__draw_config draw $__keymap_yaml $__combos_yaml > $__keymap_svg
} $@