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