5.0 KiB
Maddy's SurfingKeys Configuration
This is my configuration for the SurfingKeys browser extension.
Its primary features include
- [Site-Specific Key Mappings](#site-specific-key-mappings) which **automate common actions** on many popular websites
- [Search Suggestion Engines](#search-suggestion-engines) providing **interactive search suggestions** from dozens of knowledge sources
Table of Contents
- Site-Specific Key Mappings
- Search Suggestion Engines
- Installation Instructions
- Screenshots
- Todo
- License
Features
Site-Specific Key Mappings
key mappings for uniquesites have been included which can help you perform some common actions:
Search Suggestion Engines
There are currently search suggestion engines.
You can access a search suggestion prompt by pressing the search leader key, which is a
by default, followed by the search engine alias.
For example, to open the Wikipedia suggestion engine, you would type awp
while in normal mode.
Alias | Name | Domain | Screenshots |
---|
Installation
Dependencies
Building surfingkeys-conf
requires a few dependencies to be installed:
- Surfingkeys
^0.9.40
- git
- node
- gulp
Building & Installing
-
Clone this repository
$ git clone http://github.com/b0o/surfingkeys-conf $ cd surfingkeys-conf
-
Install the NodeJS build dependencies
$ npm install
-
(Optional) Private API Key Configuration
Some search suggestion engines require private API keys for access. These keys are defined in
conf.priv.js
, which is not itself included in this repository. An example configuration containing instructions on how to generate each API key can be found in conf.priv.example.js.Copy the example private configuration:
$ cp ./conf.priv.example.js ./conf.priv.js
Open
./conf.priv.js
in your favorite editor and follow the instructions inside:$ vim ./conf.priv.js
-
Gulp Build/Install
$ gulp install # OR "gulp build" to build to ./build/surfingkeys.js without installing
This will build the final configuration file and place it at
~/.config/surfingkeys.js
. If you already have a file in that location, make sure you back it up first! -
Load your configuration into the SurfingKeys Extension
Option A (recommended): Configure SurfingKeys to automatically load configuration file from disk
-
I. Visit
chrome://extensions/
and enableAllow access to file URLs
for the Surfingkeys extension -
II. Open the SurfingKeys configuration page
-
III. Set the
Load settings from
option to point to the configuration file.Note: you must specify the full, absolute path; environment variables like
$HOME
or the tilde~
won't work:- Linux:
file:///home/{USERNAME}/.config/surfingkeys.js
(replace{USERNAME}
with your username) - macOS:
file:///Users/{USERNAME}/.config/surfingkeys.js
(replace{USERNAME}
with your username) - Windows:
file://%Homedrive%%Homepath%/surfingkeys.js
(This is a guess, please correct me if I'm wrong)
- Linux:
-
IV. Hack Away! If you ever make a change to any of your configuration files in the future, simply run
gulp install
again and your new configuration will automatically be loaded by SurfingKeys.
Option B: Manually copy/paste into the SurfingKeys configuration form
-
I. Copy the contents of
./build/surfingkeys.js
(or$HOME/.config/surfingkeys.js
if you rangulp install
) -
II. Open the SurfingKeys configuration page
-
III. Paste into the text box, then press
save
-
IV. Repeat steps 4 & 5 after any changes you make to any of your configuration files.
-
Screenshots
Todo
- Add
CHANGELOG.md
using conventional-changelog - Improve code organization
- Ensure screenshots have a plain white background
- Add additional screenshots
- Simplify installation process
- Feed the kittens
License
©2017-2019 Maddison Hellstrom - MIT License