Maddy's SurfingKeys Configuration ================================= This is my configuration for the [SurfingKeys](https://github.com/brookhong/Surfingkeys) browser extension. Its primary features include - [Site-Specific Key Mappings](#site-specific-key-mappings) which **automate common actions** on many popular websites - [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 key mappings for unique sites have been included which can help you perform some common actions: ### Search Suggestion Engines There are currently search suggestion engines. You can access a search suggestion prompt by pressing the search leader key, which is `a` by default, followed by the search engine alias. For example, to open the Wikipedia suggestion engine, you would type `awp` while in normal mode.

Alias		Name	Domain	Screenshots

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 suggestion engines 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.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! 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}/.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.

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.__ 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 ----------- 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 Copyright ---------