jab2870/Vim-Vixen
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #120 from cozywigwam/master

Browse source 
Minor adjustments in readme for clarification
This commit is contained in:
Shin'ya Ueoka 2017-10-30 21:59:36 +00:00 • committed by GitHub
commit c4996ef5d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -3,14 +3,14 @@
Vim Vixen is a Firefox add-on which allows you to navigate with keyboard on the browser. Vim Vixen is a Firefox add-on which allows you to navigate with keyboard on the browser.
Firefox started to support WebExtensions API and will stop supporting add-ons using legacy APIs from version 57. Firefox started to support WebExtensions API and will stop supporting add-ons using legacy APIs from version 57.
For this reason, many legacy add-ons do not work on Firefox 57. For this reason, many legacy add-ons do not work on Firefox 57.
and Vim Vixen is a new choise for Vim users since Vim Vixen uses WebExtensions API Vim Vixen is a new choice for Vim users since Vim Vixen uses the WebExtensions API.
## Basic usage ## Basic usage
### Key-maps ### Key-maps
The key-maps are configurable in preferences of the add-ons. The key-maps are configurable in the add-ons preferences by navigating to `about:addons` and selecting "Extensions".
The default mapping are shown in the following. The default mappings are as follows:
#### Console #### Console
@ -51,34 +51,33 @@ The default mapping are shown in the following.
### Console commands ### Console commands
Vim-Vixen provides a console like the Vimperator's one. Vim Vixen provides a console for `ex`-style commands similar to Vimperator.
Open the console with <kbd>:</kbd>. Or start it with initial values using Open the console with <kbd>:</kbd>. Or start it with initial values using
<kbd>o</kbd>, <kbd>t</kbd>, or <kbd>w</kbd>. <kbd>o</kbd>, <kbd>t</kbd>, or <kbd>w</kbd>.
#### `:open` command #### `:open` command
Open a URL or search keywords by search engine in current tab, The `:open` command operates two different ways, depending on the parameter.
When specified parameter is formatted in URL as following, URL is opened to current tab. When the parameter is a URL, that URL is opened in the current tab.
``` ```
:open http://github.com/ueokande :open http://github.com/ueokande
``` ```
If specified parameters are keywords as following, open new tab searched by the Otherwise, the current tab will open a search page with the supplied string (defaults to Google).
keywords with search engines (default to Google).
``` ```
:open How to contribute to Vim-Vixen :open How to contribute to Vim-Vixen
``` ```
You can specify search engines in first parameter. To use a search engine other than the default, specify which search engine to use as the first parameter.
For the default of search engines, see [search engines](#search-engines) section.
``` ```
:open yahoo How to contribute to Vim-Vixen :open yahoo How to contribute to Vim-Vixen
``` ```
To adjust the search engine default and add/remove search engines, see the [search engines](#search-engines) section.
#### `:tabopen` command #### `:tabopen` command
@ -94,12 +93,11 @@ Select tabs by URL or title matched by keywords.
### Search engines ### Search engines
Vim-Vixen support to search by search engines such as google or yahoo. Vim Vixen supports search by search engines like Google and Yahoo.
But the engines are independent on browsers' because of there is a limitation of WebExtensions.
You can configure search engines and default search engine in preferences of the add-ons. You can configure search engines, including the default search engine, in the add-ons preferences.
The URLs specified in `"engines"` must contain a {}-placeholder, which will The URLs specified in `"engines"` must contain a {}-placeholder, which will be
replaced with keywords in parameters of the command. replaced with the search keyword parameters of the command.
```json ```json
{ {
@ -119,10 +117,9 @@ replaced with keywords in parameters of the command.
### Blacklist ### Blacklist
Blacklist allows to disable the plugin for certain pages by URL patterns. The blacklist allows you to disable the plugin for certain pages by URL patterns.
For instance, when you describe `"*.slack.com"`, the plugin is disabled on any Slack rooms. For instance, when you describe `"*.slack.com"`, the plugin is disabled on any Slack rooms.
In addition, you can also specify path patterns, such as `"example.com/mail/*"`. In addition, you can also specify path patterns, such as `"example.com/mail/*"`.
Disabled plugin can be made re-enabled by Shift+Esc (in default).
```json ```json
{ {
@ -133,6 +130,8 @@ Disabled plugin can be made re-enabled by Shift+Esc (in default).
} }
``` ```
You can toggle Vim Vixen between disabled and enabled with `shift + Esc`.
## Licence ## Licence
MIT MIT