Maddison's SurfingKeys Configuration

This is my configuration for the SurfingKeys browser extension.

It includes:

• 261 key mappings for 101 unique websites which automate many common actions.
• Omnibar integration with 54 Search Engines and Knowledge Sources, many of which include inline images and instant answers.

Table of Contents

1. Site-Specific Key Mappings
2. Omnibar Search Engine Integrations
3. Installation Instructions
4. Screenshots
5. License

Features

Site-Specific Key Mappings

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
K	Scroll half page up
J	Scroll half page down
gh	Scroll to element targeted by URL hash
gi	Edit current URL with vim editor
gi	Edit current URL with vim editor
gI	View image in new tab
g.	Go to parent domain
yp	Copy URL path of current page
yI	Copy Image URL
yA	Copy link as Markdown
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
=A	Show Alexa.com info for domain
=s	View social discussions for page
=o	Show outline.com version of page
=bw	Show BuiltWith report for page
=wa	Show Wappalyzer report for page
;pd	Toggle PDF viewer from SurfingKeys
gxE	Close tab to left
gxR	Close tab to right
\cgh	Open clipboard string as GitHub path (e.g. 'torvalds/linux')
F	Open a link in non-active new tab
oh	Open URL from history
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
aur.archlinux.org
Mapping	Description
<Space>a	View package
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
devdocs.io
Mapping	Description
w	Scroll sidebar up
s	Scroll sidebar down
e	Scroll sidebar page up
d	Scroll sidebar page down
k	Scroll body up
j	Scroll body down
K	Scroll body page up
J	Scroll body page down
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
<Space>sgh	Search site:github.com
<Space>sre	Search site:reddit.com
ebay.com
Mapping	Description
<Space>fs	Fakespot
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>N	Open notifications 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>yy	Copy Project Path
<Space>Y	Copy Project Path (including domain)
<Space>l	Toggle repo language stats
<Space>D	View GoDoc for Project
<Space>G	View on SourceGraph
<Space>r	View live raw version of file
<Space>yr	Copy raw link to file
<Space>yf	Copy link to file
<Space>gcp	Open clipboard string as file path in repo
github.io
Mapping	Description
<Space>R	Open Repository page
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
home.nest.com
Mapping	Description
=	Increment temperature
-	Decrement temperature
<Space>h	Switch mode to Heat
<Space>c	Switch mode to Cool
<Space>r	Switch mode to Heat/Cool
<Space>o	Switch mode to Off
<Space>f	Switch fan On
<Space>F	Switch fan Off
ikea.com
Mapping	Description
<Space>d	Toggle Product Details
<Space>i	Toggle Product Details
<Space>r	Toggle Product Reviews
<Space>C	Open Cart page
<Space>P	Open Profile page
<Space>F	Open Favorites page
<Space>O	Open Orders page
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
raw.githubusercontent.com
Mapping	Description
<Space>R	Open Repository page
<Space>F	Open Source File
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)
rescript-lang.org
Mapping	Description
i	Focus search field
<Space>a	Open docs link
<Space>L	Open language manual
<Space>R	Open ReScript + React docs
<Space>G	Open GenType docs
<Space>P	Open package index
<Space>Y	Open playground
<Space>S	Open syntax lookup
<Space>F	Open community forum
<Space>A	Open API docs
<Space>J	Open JS API docs
<Space>B	Open Belt API docs
<Space>D	Open DOM API docs
w	Scroll sidebar up
s	Scroll sidebar down
e	Scroll sidebar page up
d	Scroll sidebar page down
k	Scroll body up
j	Scroll body down
K	Scroll body page up
J	Scroll body page down
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>u	Goto user
<Space>t	Goto tweet
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
<Space>ys	Copy article summary as Markdown
<Space>R	View WikiRank for current article
www.google.com
Mapping	Description
<Space>a	Open search result
<Space>A	Open search result (new tab)
<Space>d	Open search in DuckDuckGo
www.yelp.com
Mapping	Description
<Space>fs	Fakespot
youtube.com
Mapping	Description
A	Open video
C	Open channel
gH	Goto homepage
F	Toggle fullscreen
Yt	Copy YouTube video link for current time
Ym	Copy YouTube video markdown link for current time

There are also mappings to open academic papers from 70+ publishers using a DOI handler.

Omnibar Search Engine Integrations

To open the omnibar integration for a search engine, press the search leader key (a by default) followed by the alias for the desired search engine, as found in the table below.

For example, to open the Wikipedia omnibar integration, type awp.

Alias		Name	Domain	Screenshots
	D	duckduckgo-lucky	duckduckgo.com
	G	google-lucky	www.google.com
	af	archforums ∗	bbs.archlinux.org
	al	archlinux ∗	www.archlinux.org
	at	alternativeTo ∗	alternativeto.net
	au	AUR	aur.archlinux.org	🖼️
	aw	archwiki	wiki.archlinux.org
	az	amazon	smile.amazon.com	🖼️
	ci	caniuse	caniuse.com
	cl	craigslist	www.craigslist.org
	cs	chromestore ∗	chrome.google.com
	dd	duckduckgo	duckduckgo.com
	de	define	onelook.com	🖼️
	dh	dockerhub	hub.docker.com	🖼️
	di	duckduckgo-images	duckduckgo.com
	dm	duckduckgo-maps	duckduckgo.com
	dn	duckduckgo-news	duckduckgo.com
	do	domainr	domainr.com	🖼️
	dv	duckduckgo-videos	duckduckgo.com
	eb	ebay	www.ebay.com
	fa	firefox-addons	addons.mozilla.org	🖼️
	fe	firefox-extensions	addons.mozilla.org
	ft	firefox-themes	addons.mozilla.org
	gI	google-reverse-image	www.google.com
	gg	golang ∗	golang.org
	gh	github	github.com	🖼️
	gi	google-images	www.google.com
	go	google	www.google.com
	gs	google-scholar	scholar.google.com
	hd	hexdocs	hex.pm
	hf	huggingface	huggingface.co
	hn	hackernews	news.ycombinator.com	🖼️
	ho	hoogle	www.haskell.org	🖼️
	hw	haskellwiki	wiki.haskell.org
	hx	hex	hex.pm
	jq	jquery ∗	jquery.com
	ka	kagi	kagi.com
	md	mdn	developer.mozilla.org	🖼️
	no	node ∗	nodejs.org
	np	npm	www.npmjs.com
	ow	owasp	www.owasp.org
	re	reddit	www.reddit.com	🖼️🖼️
	se	stackexchange	stackexchange.com
	so	stackoverflow	stackoverflow.com
	th	thesaurus	www.onelook.com	🖼️
	tw	twitter	twitter.com
	un	unicode †	unicode-table.com	🖼️
	vw	vimwiki	vim.fandom.com
	wa	wolframalpha ∗	www.wolframalpha.com	🖼️🖼️
	wp	wikipedia	en.wikipedia.org	🖼️
	ws	wikipedia-simple	simple.wikipedia.org
	wt	wiktionary	en.wiktionary.org
	yp	yelp	www.yelp.com
	yt	youtube ∗	www.youtube.com	🖼️

∗ requires private API key

† requires local webserver

Installation

Requires Surfingkeys v1.0.0 or newer.

Pre-built

Coming soon!

Build and Install

Dependencies

• git
• node.js v17

Procedure

1. Clone

   $ git clone http://github.com/b0o/surfingkeys-conf
   $ cd surfingkeys-conf

2. Install Node.js dependencies

   $ npm install

3. Gulp Build/Install

   $ npm run gulp install # OR "npm run gulp build" to build to ./build/surfingkeys.js without installing

   This will build the final configuration file and place it at ~/.config/surfingkeys.js. If you already have a file in that location, make sure you back it up first!

4. Load your configuration into the SurfingKeys Extension

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

   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://gfbliohnnapiefjpjlpjnehglfpaknnc/pages/options.html.

   • III. Set the Load settings from option to point to the configuration file.

     Note: you must specify the full, absolute path; the tilde ~ or environment variables like $HOME 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. Repeat these steps after you make any changes to your configuration files. Your new configuration will be automatically loaded by SurfingKeys.

   Local Web Server (Chrome, Chromium, and Firefox)

   • I. Run the configuration file server:

     See Running the Local Web Server

   • II. Open the SurfingKeys configuration page:

     Chrome: chrome-extension://gfbliohnnapiefjpjlpjnehglfpaknnc/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. SurfingKeys will lose the settings as soon as the local web server shuts down. You will likely want to configure your system to automatically start the server on login.

     If you run Linux with systemd, an example user service is provided in this repo. You will need to modify it to contain the proper path to your surfingkeys-conf repo.

   • V. Repeat the npm run gulp build command from step 4 above after you make any changes to your configuration files. Your new configuration will be automatically loaded by the web server and SurfingKeys will pick it up the next time you load a webpage.

   Option B: Manually copy/paste into the SurfingKeys configuration form

   • I. Copy the contents of ./build/surfingkeys.js (or $HOME/.config/surfingkeys.js if you ran gulp install)

   • II. Paste the contents into the SurfingKeys configuration page:

     Chrome: chrome-extension://gfbliohnnapiefjpjlpjnehglfpaknnc/pages/options.html

     Firefox: moz-extension://7b04efeb-0b36-47f6-9f57-70293e5ee7b2/pages/options.html

   • III. Repeat these steps after you make any changes to your configuration files. Your new configuration will be automatically loaded by SurfingKeys.

Optional: Private API Key Configuration

Some omnibar search engine integrations require private API keys for access (marked with a ∗ in the table above). These keys are to be defined in ./src/conf.priv.js, which should be created based on the template: ./src/conf.priv.example.js. The template contains instructions on how to generate each API key.

Note: The ./src/conf.priv.js does not exist in the repository, you need to copy the template file. The conf.priv.js should not be commited!

1. Copy the example private configuration:

$ cp ./src/conf.priv.example.js ./src/conf.priv.js

2. Open ./src/conf.priv.js in your favorite editor and follow the instructions inside:

$ vim ./src/conf.priv.js

Running the Local Web Server

This project provides a local web server which:

• Serves your configuration file via HTTP
• Serves additional API routes for certain search engines, like the unicode search engine.

To run the local web server, follow steps 1-3 in the installation instructions above, then run:

$ gulp serve-simple

Alternatively, you can use the gulp serve task, which also automatically rebuilds the configuration file whenever a source file is modified.

If you wish to use the local web server, you will likely want it to start automatically with your PC. If you run Linux with systemd, an example user service is provided for this purpose. You will need to modify it to contain the proper path to your surfingkeys-conf repo.

Note: This starts a local web server on localhost:9919 which serves your built configuration file and additional API endpoints. Depending on your firewall configuration, other devices on your network 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.

Screenshots

AUR

amazon

define

dockerhub

domainr

firefox-addons

github

hackernews

hoogle

mdn

reddit

reddit 2

thesaurus

unicode

wolframalpha

wolframalpha 2

wikipedia

youtube

Copyright

Author

License