README.md

   1 # VimFx – Vim keyboard shortcuts for Firefox
   2
   3 <img src="extension/skin/icon128.png" alt="" align="right">
   4
   5 [VimFx] is a [Mozilla Firefox] extension which adds Vim-style keyboard shortcuts
   6 for browsing and navigation, significantly reducing the use of the mouse, and
   7 allowing your hands to rest on the home row.
   8
   9 VimFx was inspired by [Vimperator] and designed after [Vimium] for [Google
  10 Chrome], preserving the shortcuts and behavior. If you are used to Vimium then
  11 it will be easy to get started with VimFx.
  12
  13 Check out the [documentation] and the [wiki]!
  14
  15 VimFx is made by [these awesome people][people].
  16
  17 [VimFx]: https://addons.mozilla.org/firefox/addon/vimfx
  18 [Mozilla Firefox]: https://www.mozilla.org/firefox
  19 [Vimperator]: http://www.vimperator.org/vimperator
  20 [Vimium]: http://vimium.github.io/
  21 [Google Chrome]: https://www.google.com/chrome
  22 [documentation]: https://github.com/akhodakivskiy/VimFx/tree/master/documentation
  23 [wiki]: https://github.com/akhodakivskiy/VimFx/wiki
  24 [people]: https://github.com/akhodakivskiy/VimFx/blob/master/PEOPLE.md
  25
  26 ## Why VimFx was created
  27
  28 > Even before Vimium there was Vimperator for Firefox. In my opinion the problem
  29 > with Vimperator is that it has too many features and aggressively changes the
  30 > default Firefox appearance and behavior. Vimium was developed for Google Chrome
  31 > and it was exactly what I needed in terms of added functionality. That's why I
  32 > decided to develop similar extension for Firefox.
  33 >
  34 > VimFx will be nice to your browser and to your habits. Promise.
  35 >
  36 > – _Anton Khodakivskiy,_ VimFx’s original author.
  37
  38 ## Key Features
  39
  40 VimFx has concise shortcuts for most commonly performed actions. Many simply
  41 invoke native Firefox features. That is preferred over re-implementing similar
  42 functionality.
  43
  44 Follow links, focus text inputs and click buttons using hint markers by pressing
  45 <kbd>f</kbd>. This command has many variations to for example copy links and
  46 open links in new tabs.
  47
  48 Search with <kbd>/</kbd> and cycle between matches with <kbd>n</kbd> and
  49 <kbd>N</kbd>.
  50
  51 Open a new tab with <kbd>t</kbd>, close it with <kbd>x</kbd>. Reopen it again
  52 with <kbd>X</kbd>. There are many more tab related commands, for example to
  53 change the currently selected tab.
  54
  55 Scrolling left/down/up/right: <kbd>h</kbd>, <kbd>j</kbd>, <kbd>k</kbd>, <kbd>l</kbd>.
  56 Top/Bottom: <kbd>gg</kbd>, <kbd>G</kbd>.
  57 Page up/down: <kbd>space</kbd>, <kbd>shift-space</kbd>.
  58 Half a page: <kbd>d</kbd>, <kbd>u</kbd>.
  59
  60 There are of course many more [shortcuts]! Press <kbd>?</kbd> to see them all.
  61 Open VimFx’s [settings] page in the Add-ons Manager to customize the [default
  62 shortcuts].
  63
  64 [shortcuts]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/commands.md
  65 [settings]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/options.md
  66 [default shortcuts]: https://github.com/akhodakivskiy/VimFx/blob/master/extension/lib/defaults.coffee
  67
  68 ## Feedback
  69
  70 Enjoying VimFx? [Write a review][review]!
  71
  72 Found a bug? Report it in the [issue tracker]!
  73
  74 Read the [contribution tips] before opening issues and pull requests.
  75
  76 [review]: https://addons.mozilla.org/firefox/addon/vimfx/reviews/add
  77 [issue tracker]: https://github.com/akhodakivskiy/VimFx/issues
  78 [contribution tips]: https://github.com/akhodakivskiy/VimFx/blob/master/CONTRIBUTING.md