README.md

   1 # VimFx – Vim keyboard shortcuts for Firefox
   2
   3 <img src="https://raw.githubusercontent.com/akhodakivskiy/VimFx/develop/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 **Mailing list:** [vimfx@librelist.com] (just send an email to subscribe)
  14
  15 Read [CONTRIBUTING.md] before opening issues and pull requests.
  16
  17 VimFx is made by [these awesome people][people].
  18
  19 [VimFx]: https://addons.mozilla.org/firefox/addon/vimfx
  20 [Mozilla Firefox]: https://www.mozilla.org/firefox
  21 [Vimperator]: http://www.vimperator.org/vimperator
  22 [Vimium]: http://vimium.github.io/
  23 [Google Chrome]: https://www.google.com/chrome
  24 [vimfx@librelist.com]: mailto:vimfx@librelist.com?subject=Subscribe
  25 [CONTRIBUTING.md]: https://github.com/akhodakivskiy/VimFx/blob/develop/CONTRIBUTING.md
  26 [people]: https://github.com/akhodakivskiy/VimFx/blob/develop/PEOPLE.md
  27
  28 ## Why VimFx was created
  29
  30 > Even before Vimium there was Vimperator for Firefox. In my opinion the problem
  31 > with Vimperator is that it has too many features and aggressively changes the
  32 > default Firefox appearance and behavior. Vimium was developed for Google Chrome
  33 > and it was exactly what I needed in terms of added functionality. That's why I
  34 > decided to develop similar extension for Firefox.
  35 >
  36 > VimFx will be nice to your browser and to your habits. Promise.
  37 >
  38 > <footer>– <cite>Anton Khodakivskiy</cite>, VimFx’s original author.</footer>
  39
  40 ## Key Features
  41
  42 VimFx has concise shortcuts for most commonly performed actions. Many simply
  43 invoke native Firefox features. That is preferred over re-implementing similar
  44 functionality.
  45
  46 Follow links, focus text inputs and click buttons using hint markers by pressing
  47 <kbd>f</kbd>. This command has many variations to for example copy links and
  48 open links in new tabs.
  49
  50 Search with <kbd>/</kbd> and cycle between matches with <kbd>n</kbd> and
  51 <kbd>N</kbd>.
  52
  53 Open a new tab with <kbd>t</kbd>, close it with <kbd>x</kbd>. Reopen it again
  54 with <kbd>X</kbd>. There are many more tab related commands, for example to
  55 change the currently selected tab.
  56
  57 Scrolling left/down/up/right: <kbd>h</kbd>, <kbd>j</kbd>, <kbd>k</kbd>, <kbd>l</kbd>.
  58 Top/Bottom: <kbd>gg</kbd>, <kbd>G</kbd>.
  59 Page up/down: <kbd>space</kbd>, <kbd>shift-space</kbd>.
  60 Half a page: <kbd>d</kbd>, <kbd>u</kbd>.
  61
  62 There are of course many more shortcuts! Press <kbd>?</kbd> to see them all.
  63 That opens the keyboard shortcuts dialog, which helps you remember the
  64 shortcuts, and lets you customize every single one of them. You can also look at
  65 all default shortcuts [here][defaults].
  66
  67 [defaults]: https://github.com/akhodakivskiy/VimFx/blob/develop/extension/lib/defaults.coffee
  68
  69 ## Feedback
  70
  71 Enjoying VimFx? [Write a review][review]!
  72
  73 Found a bug? Report it in the [issue tracker]!
  74
  75 [review]: https://addons.mozilla.org/firefox/addon/vimfx/reviews/add
  76 [issue tracker]: https://github.com/akhodakivskiy/VimFx/issues