surfingkeys-conf

Go to file

Maddison Hellstrom d8e8c0ab25 Improve organization in completions.js Also added a few new completions		2017-11-17 06:30:47 -08:00
assets	Add screenshots	2017-10-30 23:56:35 -07:00
.editorconfig	Add .editorconfig	2017-11-17 06:24:39 -08:00
.gitignore	Initial commit	2017-08-27 20:24:24 -07:00
.jshintrc	Add gulp-jshint	2017-09-17 16:25:38 -07:00
README.md	Fix grammar	2017-10-30 23:58:37 -07:00
README.tmpl.md	Fix grammar	2017-10-30 23:58:37 -07:00
completions.js	Improve organization in completions.js	2017-11-17 06:30:47 -08:00
conf.js	Add binding to check repo star status	2017-11-14 00:14:46 -08:00
conf.priv.example.js	Improve organization in completions.js	2017-11-17 06:30:47 -08:00
gulpfile.js	Add gulp-autoreload: reload gulpfile on change	2017-11-17 06:29:09 -08:00
package-lock.json	Slight refactor, add automatic README generation	2017-10-30 22:39:21 -07:00
package.json	Slight refactor, add automatic README generation	2017-10-30 22:39:21 -07:00

README.md

Maddy's SurfingKeys Configuration

This is my personal configuration for the wonderful SurfingKeys Chrome Extension.

Bundled Search Engine Completions
Installation Instructions
Screenshots
License

Bundled Search Engine Completions

There are currently 36 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
`al`	`archlinux`	`www.archlinux.org`
`au`	`AUR`	`aur.archlinux.org`
`aw`	`archwiki`	`wiki.archlinux.org`
`az`	`amazon`	`smile.amazon.com`
`cl`	`craigslist`	`craigslist.org`
`co`	`crunchbase-orgs`	`www.crunchbase.com`
`cp`	`crunchbase-people`	`www.crunchbase.com`
`cs`	`chromestore`	`chrome.google.com`
`de`	`define`	`onelook.com`
`dg`	`duckduckgo`	`duckduckgo.com`
`dh`	`dockerhub`	`hub.docker.com`
`do`	`domainr`	`domainr.com`
`ex`	`exdocs`	`hex.pm`
`gd`	`godoc`	`godoc.org`
`gh`	`github`	`github.com`
`gl`	`google-lucky`	`www.google.com`
`go`	`google`	`www.google.com`
`gs`	`go-search`	`go-search.org`
`ha`	`hackage`	`hackage.haskell.org`
`hd`	`hexdocs`	`hex.pm`
`hn`	`hackernews`	`hn.algolia.com`
`ho`	`hoogle`	`www.haskell.org`
`hw`	`haskellwiki`	`wiki.haskell.org`
`hx`	`hex`	`hex.pm`
`hy`	`hayoo`	`hayoo.fh-wedel.de`
`md`	`mdn`	`developer.mozilla.org`
`np`	`npm`	`www.npmjs.com`
`ow`	`owasp`	`www.owasp.org`
`re`	`reddit`	`www.reddit.com`
`so`	`stackoverflow`	`stackoverflow.com`
`th`	`thesaurus`	`www.onelook.com`
`vw`	`vimwikia`	`vim.wikia.com`
`wa`	`wolframalpha`	`www.wolframalpha.com`
`wp`	`wikipedia`	`en.wikipedia.org`
`yp`	`yelp`	`www.yelp.com`
`yt`	`youtube`	`www.youtube.com`

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 enable Allow 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.)

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.