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