[](http://commitizen.github.io/cz-cli/) [](https://liberapay.com/b0o/donate) Maddy's SurfingKeys Configuration ================================= This is my personal configuration for the wonderful [SurfingKeys](https://github.com/brookhong/Surfingkeys) browser extension. Its primary features include [keybindings for performing common actions](#site-specific-key-mappings) on many popular sites, as well as OmniBar support for [auto-completing searches](#bundled-search-engine-completions) within 44 sites (and growing)! Table of Contents ----------------- 1. [Site-Specific Key Mappings](#site-specific-key-mappings) 2. [Bundled Search Engine Completions](#bundled-search-engine-completions) 3. [Installation Instructions](#installation) 4. [Screenshots](#screenshots) 5. [Todo](#todo) 6. [License](#license) Features -------- ### Site-Specific Key Mappings 181 key mappings for 16 unique sites have been included which can help you perform some common actions:

global
Mapping	Description
w	Scroll up
s	Scroll down
gi	Edit current URL with vim editor
gi	Edit current URL with vim editor
gI	View image in new tab
yp	Copy URL path of current page
yI	Copy Image URL
;se	Edit Settings
gS	Open Chrome settings
=w	Lookup whois information for domain
=d	Lookup dns information for domain
=D	Lookup all information for domain
;pd	Toggle PDF viewer from SurfingKeys
amazon.com
Mapping	Description
<Space>fs	Fakespot
behance.net
Mapping	Description
<Space>s	Appreciate project
<Space>b	Add project to collection
<Space>a	View project
<Space>A	View project (new tab)
dribbble.com
Mapping	Description
<Space>s	Heart Shot
<Space>a	View shot
<Space>A	View shot (new tab)
<Space>v	View attachment image
<Space>V	Yank attachment image source URL
<Space>z	Zoom shot
fonts.adobe.com
Mapping	Description
<Space>a	Activate font
<Space>s	Favorite font
github.com
Mapping	Description
<Space>a	View Repository
<Space>u	View User
<Space>f	View File
<Space>i	View Issue
gp	Go to parent
<Space>s	Toggle Star
<Space>S	Check Star
<Space>y	Copy Project Path
<Space>Y	Copy Project Path (including domain)
<Space>D	View GoDoc for Project
gitlab.com
Mapping	Description
<Space>s	Toggle Star
<Space>y	Copy Project Path
<Space>Y	Copy Project Path (including domain)
<Space>D	View GoDoc for Project
google.com
Mapping	Description
<Space>a	Open search result
<Space>A	Open search result (new tab)
news.ycombinator.com
Mapping	Description
<Space>x	Collapse comment
<Space>X	Collapse next comment
<Space>s	Upvote
<Space>S	Downvote
<Space>a	View post (link)
<Space>A	View post (link) (new tab)
<Space>c	View post (comments)
<Space>C	View post (comments) (new tab)
gp	Go to parent
producthunt.com
Mapping	Description
<Space>a	View product (external)
<Space>v	View product
<Space>s	Upvote product
reddit.com
Mapping	Description
<Space>x	Collapse comment
<Space>X	Collapse next comment
<Space>s	Upvote
<Space>S	Downvote
<Space>e	Expand expando
<Space>a	View post (link)
<Space>A	View post (link) (new tab)
<Space>c	View post (comments)
<Space>C	View post (comments) (new tab)
twitter.com
Mapping	Description
<Space>f	Follow user
<Space>s	Like tweet
<Space>R	Retweet
<Space>c	Comment/Reply
<Space>t	New tweet
<Space>T	Tweet to
<Space>r	Load new tweets
<Space>g	Goto user
vimeo.com
Mapping	Description
<Space>F	Toggle fullscreen
wikipedia.org
Mapping	Description
<Space>s	Toggle simple version of current article
yelp.com
Mapping	Description
<Space>fs	Fakespot
youtube.com
Mapping	Description
A	Open video
C	Open channel
gH	Goto homepage
F	Toggle fullscreen
<Space>	Play/pause

### Bundled Search Engine Completions There are currently 44 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 | | ----- | ---- | ------ | ----------- | | `af` | `archforums` | `Google Custom Search` | | | `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` | [:framed_picture:](#crunchbase-people) | | `cs` | `chromestore` | `chrome.google.com` | | | `de` | `define` | `onelook.com` | [:framed_picture:](#define) | | `dg` | `duckduckgo` | `duckduckgo.com` | | | `dh` | `dockerhub` | `hub.docker.com` | [:framed_picture:](#dockerhub) | | `do` | `domainr` | `domainr.com` | [:framed_picture:](#domainr) | | `eb` | `ebay` | `www.ebay.com` | | | `ex` | `exdocs` | `hex.pm` | | | `gd` | `godoc` | `godoc.org` | | | `gg` | `golang` | `Google Custom Search` | | | `gh` | `github` | `github.com` | [:framed_picture:](#github) | | `gi` | `google-images` | `www.google.com` | | | `gl` | `google-lucky` | `www.google.com` | | | `go` | `google` | `www.google.com` | | | `gs` | `go-search` | `go-search.org` | | | `gw` | `gowalker` | `gowalker.org` | | | `ha` | `hackage` | `hackage.haskell.org` | | | `hd` | `hexdocs` | `hex.pm` | | | `hn` | `hackernews` | `hn.algolia.com` | [:framed_picture:](#hackernews) | | `ho` | `hoogle` | `www.haskell.org` | [:framed_picture:](#hoogle) | | `hw` | `haskellwiki` | `wiki.haskell.org` | | | `hx` | `hex` | `hex.pm` | | | `hy` | `hayoo` | `hayoo.fh-wedel.de` | | | `jq` | `jquery` | `Google Custom Search` | | | `md` | `mdn` | `developer.mozilla.org` | [:framed_picture:](#mdn) | | `no` | `node` | `Google Custom Search` | | | `np` | `npm` | `www.npmjs.com` | [:framed_picture:](#npm) | | `ow` | `owasp` | `www.owasp.org` | | | `re` | `reddit` | `www.reddit.com` | | | `so` | `stackoverflow` | `stackoverflow.com` | | | `th` | `thesaurus` | `www.onelook.com` | [:framed_picture:](#thesaurus) | | `vw` | `vimwikia` | `vim.wikia.com` | | | `wa` | `wolframalpha` | `www.wolframalpha.com` | [:framed_picture:](#wolframalpha) [:framed_picture:](#wolframalpha-2) | | `wp` | `wikipedia` | `en.wikipedia.org` | | | `ws` | `wikipedia-simple` | `simple.wikipedia.org` | | | `yp` | `yelp` | `www.yelp.com` | | | `yt` | `youtube` | `www.youtube.com` | [:framed_picture:](#youtube) | Installation ------------ ### Dependencies Building `surfingkeys-conf` requires a few dependencies to be installed: - __Surfingkeys__ `^0.9.40` - __git__ - __node__ - __gulp__ ### Building & Installing 1. __Clone this repository__ ```shell $ git clone http://github.com/b0o/surfingkeys-conf $ cd surfingkeys-conf ``` 2. __Install the NodeJS build dependencies__ ```shell $ npm install ``` 3. __*(Optional)* Private API Key Configuration__ Some Search Engine Auto-Completions 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](./conf.priv.example.js). Copy the example private configuration: ```shell $ cp ./conf.priv.example.js ./conf.priv.js ``` Open `./conf.priv.js` in your favorite editor and follow the instructions inside: ```shell $ vim ./conf.priv.js ``` 4. __Gulp Build/Install__ ```shell $ 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 into the SurfingKeys Extension__

Option A (recommended): Configure SurfingKeys to automatically load configuration file from disk

- __I.__ Visit [`chrome://extensions/`](chrome://extensions/) and enable `Allow access to file URLs` for the Surfingkeys extension - __II.__ Open the SurfingKeys [configuration page](chrome-extension://mffcegbjcdejldmihkogmcnkgbbhioid/pages/options.html) - __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) - __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 ran `gulp install`) - __II.__ Open the SurfingKeys [configuration page](chrome-extension://mffcegbjcdejldmihkogmcnkgbbhioid/pages/options.html) - __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 ----------- ##### crunchbase-people  ##### define  ##### dockerhub  ##### domainr  ##### github  ##### hackernews  ##### hoogle  ##### mdn  ##### npm  ##### thesaurus  ##### wolframalpha  ##### wolframalpha 2  ##### youtube  Todo ---- - [ ] Add `CHANGELOG.md` using [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) - [ ] Improve code organization - [ ] Ensure screenshots have a plain white background - [ ] Add additional screenshots - [x] Simplify installation process - [x] Feed the kittens License ------- ©2017-2018 Maddison Hellstrom - MIT License