Skip to content

Repository files navigation

KeymapKit

The presentation layer for your keyboard.

KeymapKit provides a UI for displaying keyboard layouts, including key legends, multiple layers, drawing diagram lines to specific keys, and layout tours.

See it in action on its documentation site.

It looks like this:

Screenshot

Writing your own keymap

You can generate a blank keymap for any valid keyboard model, so long as both @keymapkit/cli and the keyboard model are available in the current NPM workspace. For instance, to generate a blank ErgoDox keymap:

npm install @keymapkit/cli @keymapkit/keyboard.ergodox
npx @keymapkit/cli blank @keymapkit/keyboard.ergodox KeyboardModelErgodox

Development

Use the make file

$ makehelp Show this helplint Run eslintformat Run prettierclean Clean upmodels Build @keymapkit/modelsui Build @keymapkit/uikeyboard.advantage360 Build @keymapkit/keyboard.advantage360keyboard.ergodox Build @keymapkit/keyboard.ergodoxkeyboard.planck48 Build @keymapkit/keyboard.planck48examples Build the @keymapkit/exampleswww Build the KeymapKit website in production modewww.serve Run the KeymapKit website in development mode with hot reloadingall Build everything

About

No description, website, or topics provided.

Resources

Stars

8 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages