2.7 KiB
Maddy's SurfingKeys Configuration
Note: This configuration currently only supports SurfingKeys 0.9.14 and below.
This is my personal configuration for the wonderful SurfingKeys Chrome Extension.
Table of Contents
Bundled Search Engine Completions
There are currently Search Engine auto-completions.
You can access a Search Engine auto-completion by pressing the search leader key, which is a
by default, followed by the search engine alias.
For example, to open the Wikipedia completion, you would type awp
while in normal mode.
Alias | Name | Domain | Screenshots |
---|
Installation
Dependencies
git
node
gulp
.
1. Clone
$ git clone http://github.com/b0o/surfingkeys-conf
$ cd surfingkeys-conf
2. NPM Install
$ npm install
3. Private API Key Configuration
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
4. Gulp Build/Install
$ gulp install
This will build the final configuration file and place it in ~/.surfingkeys
.
If you already have a file in that location, make sure you back it up first!
5. Load your configuration in the SurfingKeys Extension
The final step is to tell SurfingKeys where to find your configuration file:
-
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 the correct path (substituting$USER
for your username):- Linux, MacOS, Unix:
file:///home/$USER/.surfingkeys
- Windows:
file://%Homedrive%%Homepath%/.surfingkeys
(This is a guess, please correct me if I'm wrong.)
- Linux, MacOS, Unix:
6. Hack Away!
If you ever make a change to any of your configuration files in the future, simply run gulp install
again and your settings will be immediately updated.
Screenshots
Todo
- Simplify installation process
- Improve code organization
- Ensure screenshots have a plain white background
- Add additional screenshots
- Feed the kittens
License
©2017 Maddison Hellstrom - MIT License