This repository provides an extensive configuration for the SurfingKeys browser extension, aimed at power users seeking to enhance web navigation efficiency. It offers over 265 custom key mappings across 104 websites and integrates 58 search engines and knowledge sources into the Omnibar for streamlined information retrieval.

How It Works

The configuration leverages SurfingKeys' JavaScript API to define custom keyboard shortcuts and Omnibar commands. Site-specific mappings automate common actions like scrolling, navigation, and data extraction. Omnibar integrations allow users to search various platforms directly from the address bar, often with advanced features like inline previews or instant answers, by mapping keywords to specific search queries.

Quick Start & Requirements

• Install: Clone the repository, run npm install, then npm run gulp install.
• Prerequisites: SurfingKeys extension v1.0.0+, Node.js v17+.
• Setup: Requires cloning the repo and running npm commands. Configuration involves pointing the SurfingKeys extension to the generated ~/.config/surfingkeys.js file or running a local web server.
• Docs: SurfingKeys Extension

Highlighted Details

• 265 key mappings for 104 websites.
• 58 Omnibar search engine integrations with advanced features.
• Mappings for popular sites like GitHub, Reddit, Stack Overflow, Wikipedia, and more.
• Includes DOI handler for academic papers.
• Optional private API key support for certain integrations.

Maintenance & Community

• Developed by Maddison Hellstrom.
• MIT License.

Licensing & Compatibility

• MIT License. Permissive for commercial use and integration with closed-source projects.

Limitations & Caveats

The local web server option, if used, exposes the configuration file (including potential private API keys) on localhost:9919, requiring firewall awareness. Some integrations marked with * require private API keys, which are not included and must be generated separately.