aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorShin'ya Ueoka <ueokande@i-beam.org>2018-05-01 15:51:40 +0900
committerShin'ya Ueoka <ueokande@i-beam.org>2018-05-01 15:51:40 +0900
commit9da2f5fd786ff7ef64eca0a86efb1c0b9a164244 (patch)
treeb888349817d0016dc1499932671bbe6cd95efdaa /README.md
parentf9889b7f2b634bfe5a540633d8952f4a6f900658 (diff)
parent89d6afecfd257ff4fc62748f771abf37ef3a2852 (diff)
Merge remote-tracking branch 'origin/master' into patch-1
Diffstat (limited to 'README.md')
-rw-r--r--README.md63
1 files changed, 45 insertions, 18 deletions
diff --git a/README.md b/README.md
index e8a9835..710c53b 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,11 @@
# Vim Vixen
+[![Greenkeeper badge](https://badges.greenkeeper.io/ueokande/vim-vixen.svg)](https://greenkeeper.io/)
+
+[![Join the chat room on Gitter for vim-vixen/vim-vixen](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vim-vixen/vim-vixen)
+[![CircleCI](https://circleci.com/gh/ueokande/vim-vixen.svg?style=svg)](https://circleci.com/gh/ueokande/vim-vixen)
+[![devDependencies Status](https://david-dm.org/ueokande/vim-vixen/dev-status.svg)](https://david-dm.org/ueokande/vim-vixen?type=dev)
+
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.
For this reason, many legacy add-ons do not work on Firefox 57.
@@ -19,38 +25,30 @@ The default mappings are as follows:
- <kbd>O</kbd>, <kbd>T</kbd>, <kbd>W</kbd>: similar to <kbd>o</kbd>, <kbd>t</kbd>, <kbd>w</kbd>, but that contains current URL
- <kbd>b</kbd>: Select tabs by URL or title
-#### Scrolling
-
-- <kbd>j</kbd>, <kbd>k</kbd>: scroll vertically
-- <kbd>h</kbd>, <kbd>l</kbd>: scroll horizontally
-- <kbd>Ctrl</kbd>+<kbd>U</kbd>, <kbd>Ctrl</kbd>+<kbd>D</kbd>: scroll pages by half of screen
-- <kbd>Ctrl</kbd>+<kbd>B</kbd>, <kbd>Ctrl</kbd>+<kbd>F</kbd>: scroll pages by a screen
-- <kbd>0</kbd>, <kbd>$</kbd>: scroll a page to leftmost/rightmost
-- <kbd>g</kbd><kbd>g</kbd>, <kbd>G</kbd>: scroll to top/bottom
-
#### Tabs
-- <kbd>d</kbd>: delete current tab
+- <kbd>!</kbd><kbd>d</kbd>: delete pinned tab
- <kbd>u</kbd>: reopen close tab
-- <kbd>K</kbd>, <kbd>J</kbd>: select prev or next tab
-- <kbd>g0</kbd>, <kbd>g$</kbd>: select first or last tab
- <kbd>r</kbd>: reload current tab
- <kbd>R</kbd>: reload current tab without cache
-- <kbd>zp</kbd>: toggle pin/unpin current tab
-- <kbd>zd</kbd>: duplicate current tab
### Navigation
- <kbd>f</kbd>: start following links in the page
-- <kbd>H</kbd>: go back in histories
-- <kbd>L</kbd>: go forward in histories
+- <kbd>H</kbd>: go back in history
+- <kbd>L</kbd>: go forward in history
- <kbd>[</kbd><kbd>[</kbd>, <kbd>]</kbd><kbd>]</kbd>: find prev or next links and open it
- <kbd>g</kbd><kbd>u</kbd>: go to parent directory
- <kbd>g</kbd><kbd>U</kbd>: go to root directory
+- <kbd>g</kbd><kbd>i</kbd>: focus first input
#### Misc
-- <kbd>z</kbd><kbd>i</kbd>, <kbd>z</kbd><kbd>o</kbd>: zoom-in/zoom-out
-- <kbd>z</kbd><kbd>z</kbd>: Set default zoom level
+
- <kbd>y</kbd>: copy URL in current tab
+- <kbd>p</kbd>: open clipbord's URL in current tab
+- <kbd>P</kbd>: open clipbord's URL in new tab
- <kbd>Shift</kbd>+<kbd>Esc</kbd>: enable or disable the add-on in current tab.
+- <kbd>/</kbd>: start to find a keyword in the page
+- <kbd>n</kbd>: find next keyword in the page
+- <kbd>N</kbd>: find prev keyword in the page
### Console commands
@@ -94,6 +92,35 @@ Open a URL or search keywords by search engine in new window.
Select tabs by URL or title matched by keywords.
+#### `:set` command
+
+`:set` command can set properties on console.
+
+##### `smoothscroll` property
+
+Enable/disable smooth scroll.
+```
+:set smoothscroll " enable smooth scroll
+:set nosmoothscroll " disable smooth scroll
+```
+
+##### `hintchars` property
+
+Set hint characters
+
+```
+:set hintchars=0123456789
+```
+
+##### 'adjacenttab' property
+
+Open a new tab on adjacent of the current tab.
+
+```
+:set noadjacenttab " open a tab at last
+:set adjacenttab " open a tab adjacently
+```
+
### Search engines
Vim Vixen supports search by search engines like Google and Yahoo.