Skip to content

jelford/keyn

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
js
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 

keyn

Build and Test

keyn is a browser extension that adds keyboard navigation.

Install it from:

screenshot of wikipedia page about browser extensions, with links highlighted by keyn

usage

Press Ctrl+, to show nav hints:

screenshot of this repo with links highlighted for navigation

Let's navigate to the issues page. keyn filters as you type - start with is:

screenshot showing keyn hints filtered to only highlight links starting with the letters "is"

Finally select the link you want by typing the number next to it:

screenshot showing one of the two issues links selected after typing "1"

Follow the link with Enter (Shift+Enter for a new tab, Alt+Enter for a background tab).

configuration

You can customize the activation key (default: Ctrl+,) in the addon settings screen.

  • Go to: about:addons
  • Select the cog at the top of the list
  • Select "Manage Extension Shortcuts"

developer documentation

dev setup

You will need Firefox, Chrome, their respective Webdriver plugins (for testng), and the normal Node stuff. For convenience you can use this toolbox:

toolbox create -i ghcr.io/jelford/webdev-toolbox:latest -c webdev
toolbox enter webdev
npm install

building

Build using Mozilla's web-ext tool:

web-ext lint
web-ext build

Output will be under web-ext-artifacts and should be compatible with Firefox or Chrome.

releasing

keyn uses bumpversion and a python wrapper to document/automate the release

./release.py patch # or major/minor

This will:

  • Run lints
  • Run bumpversion
  • Build a new artifact
  • Provide links to extension web stores (manual upload)

dependencies

keyn uses only one third-part dependency: webextension-polyfill. It's used in unbundled form, downloaded into the libs/ folder. Update by replacing with the latest version.

About

Navigate the world wide web with the power of the keyboard

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published