A keyboard interface to the web
Clone or download
Latest commit 499142c Sep 6, 2018

README.md

Saka Key

Saka Key is a Chrome and Firefox extension for keyboard-only web browsing. It differs from existing extensions because

  1. Its state machine architecture is modular, extensible, and SIMPLE. Its design is inspired by my frustration trying to make sense of the scattered state, confusing event handling, and dubious design of similar extensions.

  2. It's not Vim. Aesthetics matter and graphical menus takes preference over text configuration. It's friendly to non-developers. You shouldn't need a tutorial, but there is one.

  3. It's engineered for configurability. Developers define options with JSON. This JSON is used to generate the Options Page. Changes to options automatically propagate to all tabs. Options are organized into profiles, which are easy to switch between. Sensible default profiles are built-in. Options can be exported and imported.

  4. It's built with modern tools: ES6+, Webpack, Preact.

Saka Key lacks some features other extensions have today, but it has the foundation to reinvent and recreate them better than ever.

Try Saka, read the Saka Key Handbook, and ask questions on Gitter.

Install

Install from Source

Follow the Development Setup Guide for detailed instructions. Otherwise:

git clone https://github.com/lusakasa/saka-key.git
cd saka-key
npm install
# Option 1. Chrome development build
npm run build:chrome
# Option 2. Chrome production build
npm run build:chrome:prod
# Option 3. Firefox development build
npm run build:firefox
# Option 4. Firefox production build
npm run build:firefox:prod

Preview

Saka Key Preview

Credits

MIT Licensed, Copyright (c) 2018 Sufyan Dawoodjee, Neil Macintyre

Saka Key is inspired by and derives from