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