3.6 KiB
Maddy's SurfingKeys Configuration
This is my personal configuration for the wonderful SurfingKeys browser 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 # OR "gulp build" to build to ./build/.surfingkeys without installing
This will build the final configuration file and place it at ~/.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
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}/.surfingkeys
(replace{USERNAME}
with your username) - macOS:
file:///Users/{USERNAME}/.surfingkeys
(replace{USERNAME}
with your username) - Windows:
file://%Homedrive%%Homepath%/.surfingkeys
(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
(or$HOME/.surfingkeys
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
- Simplify installation process
- Improve code organization
- Ensure screenshots have a plain white background
- Add additional screenshots
- Feed the kittens
License
©2017-2018 Maddison Hellstrom - MIT License