Maddy's SurfingKeys Configuration ================================= This is my configuration for the [SurfingKeys](https://github.com/brookhong/Surfingkeys) browser extension. Its primary features include - 241 [Site-Specific Key Mappings](#site-specific-key-mappings) which **automate common actions** on many popular websites - 55 [Search Suggestion Engines](#search-suggestion-engines) providing **interactive search suggestions** from dozens of knowledge sources Table of Contents ----------------- 1. [Site-Specific Key Mappings](#site-specific-key-mappings) 2. [Search Suggestion Engines](#search-suggestion-engines) 3. [Installation Instructions](#installation) 4. [Screenshots](#screenshots) 5. [Todo](#todo) 6. [License](#license) Features -------- ### Site-Specific Key Mappings 241 key mappings for 20 unique sites have been included which can help you perform some common actions:
global | |
---|---|
Mapping | Description |
F | Open a link in non-active new tab |
zf | Open link URL in vim editor |
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 |
yO | Copy page URL/Title as Org-mode link |
yM | Copy page URL/Title as Markdown link |
yT | Duplicate current tab (non-active new tab) |
;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 |
=c | Show Google's cached version of page |
=a | Show Archive.org Wayback Machine for page |
=o | Show outline.com version of page |
=r | Subscribe to RSS feed for page |
;pd | Toggle PDF viewer from SurfingKeys |
gxE | Close tab to left |
gxR | Close tab to right |
algolia.com | |
Mapping | Description |
<Space>a | Open search result |
amazon.com | |
Mapping | Description |
<Space>fs | Fakespot |
<Space>a | View product |
<Space>c | Add to Cart |
<Space>R | View Product Reviews |
<Space>Q | View Product Q&A |
<Space>A | Open Account page |
<Space>C | Open Cart page |
<Space>O | Open Orders page |
behance.net | |
Mapping | Description |
<Space>s | Appreciate project |
<Space>b | Add project to collection |
<Space>a | View project |
<Space>A | View project (non-active new tab) |
craigslist.org | |
Mapping | Description |
<Space>a | View listing |
dribbble.com | |
Mapping | Description |
<Space>s | Heart Shot |
<Space>a | View shot |
<Space>A | View shot (non-active new tab) |
<Space>v | View attachment image |
<Space>V | Yank attachment image source URL |
<Space>z | Zoom shot |
duckduckgo.com | |
Mapping | Description |
<Space>a | Open search result |
<Space>A | Open search result (non-active new tab) |
]] | Show more results |
<Space>g | Open search in Google |
fonts.adobe.com | |
Mapping | Description |
<Space>a | Activate font |
<Space>s | Favorite font |
github.com | |
Mapping | Description |
<Space>A | Open repository Actions page |
<Space>C | Open repository Commits page |
<Space>I | Open repository Issues page |
<Space>P | Open repository Pull Requests page |
<Space>R | Open Repository page |
<Space>S | Open repository Settings page |
<Space>W | Open repository Wiki page |
<Space>X | Open repository Security page |
<Space>O | Open repository Owner's profile page |
<Space>M | Open your profile page ('Me') |
<Space>a | View Repository |
<Space>u | View User |
<Space>f | View File |
<Space>c | View Commit |
<Space>i | View Issue |
<Space>p | View Pull Request |
<Space>e | View external link |
gu | Go up one path in the URL (GitHub) |
<Space>s | Toggle Star |
<Space>y | Copy Project Path |
<Space>Y | Copy Project Path (including domain) |
<Space>l | Toggle repo language stats |
<Space>D | View GoDoc for Project |
<Space>H | View RepoHealth Report for Project |
<Space>ra | View live raw version of file |
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 |
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 and comments) |
<Space>c | View post (comments) |
<Space>C | View post (comments) (non-active new tab) |
<Space>e | View external link |
gp | Go to parent |
]] | Next page |
[[ | Prev page |
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) (non-active new tab) |
<Space>c | View post (comments) |
<Space>C | View post (comments) (non-active new tab) |
stackoverflow.com | |
Mapping | Description |
<Space>a | View question |
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 |
<Space>a | View page |
<Space>e | View external link |
www.google.com | |
Mapping | Description |
<Space>a | Open search result |
<Space>A | Open search result (non-active new tab) |
<Space>d | Open search in DuckDuckGo |
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 |
Local File Access (Chrome/Chromium only)
- __I.__ Visit `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}/.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) - __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.
Local Web Server (Chrome, Chromium, and Firefox)
- __I.__ Run the configuration file server: ```shell $ gulp serve-simple ``` Alternatively, you can use the `gulp serve` task, which automatically rebuilds the configuration file whenever a source file is modified. - __II.__ Open the SurfingKeys configuration page: Chrome: `chrome-extension://mffcegbjcdejldmihkogmcnkgbbhioid/pages/options.html` Firefox: `moz-extension://7b04efeb-0b36-47f6-9f57-70293e5ee7b2/pages/options.html` - __III.__ Set the `Load settings from` option to `http://localhost:9919` - __IV.__ You will want to configure your system to automatically run `gulp serve-simple` from the repository directory on boot, otherwise SurfingKeys will lose the settings as soon as the local web server is down. If you run Linux with systemd, an [example user service](./surfingkeys-conf.service) is provided in this repo. You will need to modify it to contain the proper path to your surfingkeys-conf repo. - __V.__ Hack Away! If you ever make a change to any of your configuration files in the future, simply run `gulp build` again and your new configuration will automatically be loaded by SurfingKeys. - __Note:__ This method starts a web server on `localhost:9919`. Depending on your firewall configuration, other devices on your local network (or the internet at large in the case of misconfigured router firewall) may be able to read your configuration file, including any private API keys or other secrets you have configured in `conf.priv.js`. Proceed with caution.