From 9db4794a88d6377ea23b08fb5619e9e9a8d02c2e Mon Sep 17 00:00:00 2001 From: Shin'ya UEOKA Date: Fri, 6 Sep 2019 04:17:44 +0000 Subject: Add help pages from readme --- docs/index.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs/index.md') diff --git a/docs/index.md b/docs/index.md index 335f668..ad7c911 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,15 @@ +--- +title: Vim Vixen +--- + # Vim Vixen Vim Vixen is a Firefox add-on which allows you to easily navigate the web by 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 + +- [Vim Vixen - GitHub](https://github.com/ueokande/vim-vixen) +- [Vim Vixen - Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/vim-vixen/) -- cgit v1.2.3 From 104c04eb68d3adfb1b4a40b6cba761d8ce460103 Mon Sep 17 00:00:00 2001 From: Shin'ya UEOKA Date: Tue, 1 Oct 2019 04:32:06 +0000 Subject: Improve documents --- docs/index.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++--- docs/keymaps.md | 50 +++++++++++++++++++++++++------------------------- 2 files changed, 73 insertions(+), 28 deletions(-) (limited to 'docs/index.md') 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 k, j, h and +l keys. You can scroll to the top or the bottom of a page by +gg and G. + +To select a left and right of current tab, use K and J +respectively. To close current tab, use d and to restore closed +tabs, use u. + +To open a link, press f 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 :. + +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 -- :: open the console -- o, t, w: open a page in the current tab, a new tab, or new window -- O, T, W: similar to o, t, w, but using the current URL -- b: select tabs by URL or title -- a: add the current page to your bookmarks +- k: scroll up +- j: scroll down +- h: scroll left +- l: scroll right +- Ctrl+U: scroll up half a page +- Ctrl+D: scroll down half a page +- Ctrl+B: scroll up a page +- Ctrl+F: scroll down a page +- gg: scroll to the top of a page +- G: scroll to the bottom of a page +- 0: scroll to the leftmost part of a page +- $: scroll to the rightmost part of a page +- m: set a mark for the current position +- ': 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 - d: delete the current tab and select the tab to its right - D: 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 - zp: pin the curent tab tab - zd: duplicate the current tab -## Scrolling +## Console -- k: scroll up -- j: scroll down -- h: scroll left -- l: scroll right -- Ctrl+U: scroll up half a page -- Ctrl+D: scroll down half a page -- Ctrl+B: scroll up a page -- Ctrl+F: scroll down a page -- gg: scroll to the top of a page -- G: scroll to the bottom of a page -- 0: scroll to the leftmost part of a page -- $: scroll to the rightmost part of a page -- m: set a mark for the current position -- ': jump to a marked position +- :: open the console +- o, t, w: open a page in the current tab, a new tab, or new window +- O, T, W: similar to o, t, w, but using the current URL +- b: select tabs by URL or title +- a: 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 -- cgit v1.2.3