Five years ago, I built keymap.click. It’s something I am incredibly proud of — I had a vision of showing something visually and I learned React from scratch to accomplish it.
I have always wanted it to be more extensible, so that I can embed it in pages here on this site, and so that other people could use it on their sites too.
So today I’m releasing a 1.0 version of KeymapKit. KeymapKit is a total rewrite of the old keymap.click code, keeping its most important aspects, allowing users to
- annotate each key to explain why it is where it is
- play guided tours of layouts to showcase a keymap holistically
- use it on small screens, including phones
While adding a bunch of new features, and now
- supports custom keyboard layouts
- can be added to any web page
- includes models for multiple physical keyboards: the ErgoDox and the Planck
- supports user-defined keyboard models, so you can write your own or publish one on NPM that other people can use
- represents multiple layers for any layout, including in guided tours
- is made of 100% dependency-free web components (no React)
Check out the documentation site to see demos of it in action and walkthroughs for showing off your own layouts.
As a result, I’m planning to retire the keymap.click project and domain name.
I’ll have the site redirect to somewhere sensible for a year or two,
but after that I’ll let it expire.
The source for the old project will remain at
mrled/keymap.click,
and I’ll keep a permanent archive
of the deployed site indefinitely.
Expect to see more keyboard layout posts in the future, now that I can add them directly to this site!