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 Firefox extension which adds Vim-style keyboard shortcuts for
   6 browsing and navigation, significantly reducing the use of the mouse.
   7
   8 - Doesn’t change your browser in any way. Everything can be disabled.
   9 - Easy for beginners, powerful for advanced users. Not just for Vim fanatics.
  10 - Modeled after [Vimium] for Chrome.
  11
  12 **New to VimFx?** Check out [Questions & Answers]!
  13 Power user? Make a [config file]!
  14 In either case, have look at the the [documentation] and the [wiki].
  15
  16 VimFx is made by [these awesome people][people].
  17
  18 [VimFx]: https://addons.mozilla.org/firefox/addon/vimfx
  19 [Vimium]: http://vimium.github.io/
  20 [Vimperator]: http://www.vimperator.org/vimperator
  21 [config file]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/config-file.md
  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,
  30 > Vimperator has too many features and aggressively changes the default Firefox
  31 > appearance and behavior. Vimium is exactly what I need in terms of added
  32 > functionality, but for Chrome. That’s why I decided to develop similar
  33 > extension for Firefox.
  34 >
  35 > &nbsp;**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
  46 pressing <kbd>f</kbd>. This command has many variations, for example to copy
  47 links or open them 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>. Switch between tabs with <kbd>J</kbd> and <kbd>K</kbd>, or
  54 some of the several other tab commands.
  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. Click on a command or open VimFx’s
  63 [settings] page in the 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 [review]: https://addons.mozilla.org/firefox/addon/vimfx/reviews/add
  80 [issue tracker]: https://github.com/akhodakivskiy/VimFx/issues