[docs:tweak] clean up README
This commit is contained in:
Maddison Hellstrom
parent
c80ef42903
commit
5c88a51204
23
README.md
23
README.md
|
|
@ -6,22 +6,20 @@ The source file is README.tmpl.md
|
|||
|
||||
-->
|
||||
|
||||
[](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.
|
||||
This is my configuration for the [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 46 sites (and growing)!
|
||||
Its primary features include
|
||||
- 216 [Site-Specific Key Mappings](#site-specific-key-mappings) which **automate common actions** on many popular websites
|
||||
- 46 [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. [Bundled Search Engine Completions](#bundled-search-engine-completions)
|
||||
2. [Search Suggestion Engines](#search-suggestion-engines)
|
||||
3. [Installation Instructions](#installation)
|
||||
4. [Screenshots](#screenshots)
|
||||
5. [Todo](#todo)
|
||||
|
|
@ -46,6 +44,7 @@ sites have been included which can help you perform some common actions:
|
|||
<tr><td><code>gI</code></td><td>View image in new tab</td></tr>
|
||||
<tr><td><code>yp</code></td><td>Copy URL path of current page</td></tr>
|
||||
<tr><td><code>yI</code></td><td>Copy Image URL</td></tr>
|
||||
<tr><td><code>yT</code></td><td>Duplicate current tab (non-active new tab)</td></tr>
|
||||
<tr><td><code>;se</code></td><td>Edit Settings</td></tr>
|
||||
<tr><td><code>gS</code></td><td>Open Chrome settings</td></tr>
|
||||
<tr><td><code>=w</code></td><td>Lookup whois information for domain</td></tr>
|
||||
|
|
@ -151,13 +150,13 @@ sites have been included which can help you perform some common actions:
|
|||
</tbody>
|
||||
</table>
|
||||
|
||||
### Bundled Search Engine Completions
|
||||
### Search Suggestion Engines
|
||||
|
||||
There are currently 46 Search Engine auto-completions.
|
||||
There are currently 46 search suggestion engines.
|
||||
|
||||
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.
|
||||
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 completion, you would type `awp` while in normal mode.
|
||||
For example, to open the Wikipedia suggestion engine, you would type `awp` while in normal mode.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
|
|
@ -525,7 +524,7 @@ Building `surfingkeys-conf` requires a few dependencies to be installed:
|
|||
|
||||
3. __*(Optional)* Private API Key Configuration__
|
||||
|
||||
Some Search Engine Auto-Completions require private API keys for access. These
|
||||
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).
|
||||
|
|
|
|||
|
|
@ -1,21 +1,19 @@
|
|||
<!--{{DISCLAIMER}}-->
|
||||
|
||||
[](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.
|
||||
This is my configuration for the [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 <!--{{COMPL_COUNT}}--> sites (and growing)!
|
||||
Its primary features include
|
||||
- <!--{{KEYS_MAPS_COUNT}}--> [Site-Specific Key Mappings](#site-specific-key-mappings) which **automate common actions** on many popular websites
|
||||
- <!--{{COMPL_COUNT}}--> [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. [Bundled Search Engine Completions](#bundled-search-engine-completions)
|
||||
2. [Search Suggestion Engines](#search-suggestion-engines)
|
||||
3. [Installation Instructions](#installation)
|
||||
4. [Screenshots](#screenshots)
|
||||
5. [Todo](#todo)
|
||||
|
|
@ -35,13 +33,13 @@ sites have been included which can help you perform some common actions:
|
|||
</tbody>
|
||||
</table>
|
||||
|
||||
### Bundled Search Engine Completions
|
||||
### Search Suggestion Engines
|
||||
|
||||
There are currently <!--{{COMPL_COUNT}}--> Search Engine auto-completions.
|
||||
There are currently <!--{{COMPL_COUNT}}--> search suggestion engines.
|
||||
|
||||
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.
|
||||
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 completion, you would type `awp` while in normal mode.
|
||||
For example, to open the Wikipedia suggestion engine, you would type `awp` while in normal mode.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
|
|
@ -87,7 +85,7 @@ Building `surfingkeys-conf` requires a few dependencies to be installed:
|
|||
|
||||
3. __*(Optional)* Private API Key Configuration__
|
||||
|
||||
Some Search Engine Auto-Completions require private API keys for access. These
|
||||
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).
|
||||
|
|
|
|||
Loading…
Reference in New Issue