diff options
| -rw-r--r-- | docs/index.md | 51 | ||||
| -rw-r--r-- | docs/keymaps.md | 50 |
2 files changed, 73 insertions, 28 deletions
diff --git a/docs/index.md b/docs/index.md index ad7c911..7917645 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,52 @@ keyboard. Since version 57, Firefox has migrated to the WebExtensions API and has dropped support for legacy add-ons. Vim Vixen is a new choice for Vim users since it uses the WebExtensions API. -## Related links +## Getting started -- [Vim Vixen - GitHub](https://github.com/ueokande/vim-vixen) -- [Vim Vixen - Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/vim-vixen/) +### Install Vim Vixen + +Vim Vixen is supported on Firefox 60 ESR. Please latest version of stable ESR +from the [download page](https://www.mozilla.org/en-US/firefox/). +You can install Vim Vixen from [Firefox add-ons (addons.mozilla.org)][AMO], and +manage installed addon-ons on Firefox preferences `about:preferences`. + +### Quick start + +After installation, you can control Firefox with vim-like keymaps. To scroll a +page in the browser, press <kbd>k</kbd>, <kbd>j</kbd>, <kbd>h</kbd> and +<kbd>l</kbd> keys. You can scroll to the top or the bottom of a page by +<kbd>g</kbd><kbd>g</kbd> and <kbd>G</kbd>. + +To select a left and right of current tab, use <kbd>K</kbd> and <kbd>J</kbd> +respectively. To close current tab, use <kbd>d</kbd> and to restore closed +tabs, use <kbd>u</kbd>. + +To open a link, press <kbd>f</kbd> to enter the **follow mode** to select a +link. Then you can select links by alphabetic keys. + +See also [Keymaps](./keymaps.html) for more detailed of keymaps. + +### Using commands + +Vim Vixen supports command line to run commands that control tabs and opens a +tab. To open command line, press <kbd>:</kbd>. + +To open a tab with URL, use `open` command as the following: + +``` +:open https://github.com/ueokande/vimvixen +``` + +or search keywords with search engine (such as Google) like: + +``` +:open How to use Vim +``` + +You can see completed commands on [Console commands](./console_commands.html). + +## Copyright + +Copyright © 2017-2019 by Shin'ya Ueoka + +[AMO]: https://addons.mozilla.org/en-US/firefox/addon/vim-vixen/ diff --git a/docs/keymaps.md b/docs/keymaps.md index 8952392..9ae0c98 100644 --- a/docs/keymaps.md +++ b/docs/keymaps.md @@ -7,17 +7,27 @@ title: Keymaps Keymaps are configurable in the add-on's preferences by navigating to `about:addons` and selecting "Extensions". The default mappings are as follows: -## Console +## Scrolling -- <kbd>:</kbd>: open the console -- <kbd>o</kbd>, <kbd>t</kbd>, <kbd>w</kbd>: open a page in the current tab, a new tab, or new window -- <kbd>O</kbd>, <kbd>T</kbd>, <kbd>W</kbd>: similar to <kbd>o</kbd>, <kbd>t</kbd>, <kbd>w</kbd>, but using the current URL -- <kbd>b</kbd>: select tabs by URL or title -- <kbd>a</kbd>: add the current page to your bookmarks +- <kbd>k</kbd>: scroll up +- <kbd>j</kbd>: scroll down +- <kbd>h</kbd>: scroll left +- <kbd>l</kbd>: scroll right +- <kbd>Ctrl</kbd>+<kbd>U</kbd>: scroll up half a page +- <kbd>Ctrl</kbd>+<kbd>D</kbd>: scroll down half a page +- <kbd>Ctrl</kbd>+<kbd>B</kbd>: scroll up a page +- <kbd>Ctrl</kbd>+<kbd>F</kbd>: scroll down a page +- <kbd>g</kbd><kbd>g</kbd>: scroll to the top of a page +- <kbd>G</kbd>: scroll to the bottom of a page +- <kbd>0</kbd>: scroll to the leftmost part of a page +- <kbd>$</kbd>: scroll to the rightmost part of a page +- <kbd>m</kbd>: set a mark for the current position +- <kbd>'</kbd>: jump to a marked position -See the [console commands](./console_commands.html) section for a more detailed description. +Lowercase marks (`[a-z]`) store the position of the current tab. Uppercase and +numeric marks (`[A-Z0-9]`) store the position and the tab. -## Tabs +## Select and manage tabs - <kbd>d</kbd>: delete the current tab and select the tab to its right - <kbd>D</kbd>: delete the current tab and select the tab to its left @@ -33,25 +43,15 @@ See the [console commands](./console_commands.html) section for a more detailed - <kbd>z</kbd><kbd>p</kbd>: pin the curent tab tab - <kbd>z</kbd><kbd>d</kbd>: duplicate the current tab -## Scrolling +## Console -- <kbd>k</kbd>: scroll up -- <kbd>j</kbd>: scroll down -- <kbd>h</kbd>: scroll left -- <kbd>l</kbd>: scroll right -- <kbd>Ctrl</kbd>+<kbd>U</kbd>: scroll up half a page -- <kbd>Ctrl</kbd>+<kbd>D</kbd>: scroll down half a page -- <kbd>Ctrl</kbd>+<kbd>B</kbd>: scroll up a page -- <kbd>Ctrl</kbd>+<kbd>F</kbd>: scroll down a page -- <kbd>g</kbd><kbd>g</kbd>: scroll to the top of a page -- <kbd>G</kbd>: scroll to the bottom of a page -- <kbd>0</kbd>: scroll to the leftmost part of a page -- <kbd>$</kbd>: scroll to the rightmost part of a page -- <kbd>m</kbd>: set a mark for the current position -- <kbd>'</kbd>: jump to a marked position +- <kbd>:</kbd>: open the console +- <kbd>o</kbd>, <kbd>t</kbd>, <kbd>w</kbd>: open a page in the current tab, a new tab, or new window +- <kbd>O</kbd>, <kbd>T</kbd>, <kbd>W</kbd>: similar to <kbd>o</kbd>, <kbd>t</kbd>, <kbd>w</kbd>, but using the current URL +- <kbd>b</kbd>: select tabs by URL or title +- <kbd>a</kbd>: add the current page to your bookmarks -Lowercase marks (`[a-z]`) store the position of the current tab. Uppercase and -numeric marks (`[A-Z0-9]`) store the position and the tab. +See the [console commands](./console_commands.html) section for a more detailed description. ## Zoom |