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 short, Vim-style keyboard shortcuts
   6 for browsing and navigation, for a near mouseless experience.
   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 Also check out **[the future of VimFx].**
  16
  17 VimFx is made by [these awesome people][people].
  18
  19 [VimFx]: https://addons.mozilla.org/firefox/addon/vimfx
  20 [Vimium]: http://vimium.github.io/
  21 [Vimperator]: http://www.vimperator.org/vimperator
  22 [config file]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/config-file.md
  23 [documentation]: https://github.com/akhodakivskiy/VimFx/tree/master/documentation#contents
  24 [wiki]: https://github.com/akhodakivskiy/VimFx/wiki
  25 [Questions & Answers]: https://github.com/akhodakivskiy/VimFx/tree/master/documentation/questions-and-answers.md
  26 [the future of VimFx]: https://github.com/akhodakivskiy/VimFx/issues/860
  27 [people]: https://github.com/akhodakivskiy/VimFx/blob/master/PEOPLE.md
  28
  29 ## Why VimFx was created
  30
  31 > Even before [Vimium] there was [Vimperator] for Firefox. In my opinion,
  32 > Vimperator has too many features and aggressively changes the default Firefox
  33 > appearance and behavior. Vimium is exactly what I need in terms of added
  34 > functionality, but for Chrome. That’s why I decided to develop a similar
  35 > extension for Firefox.
  36 >
  37 > &nbsp;**VimFx will be nice to your browser and to your habits. Promise.**
  38 >
  39 > – _Anton Khodakivskiy,_ VimFx’s original author.
  40
  41 ## Key Features
  42
  43 VimFx has concise shortcuts for most commonly performed actions. Many simply
  44 invoke standard Firefox features. That is preferred over re-implementing similar
  45 functionality.
  46
  47 Press <kbd>f</kbd> to mark links, text inputs and buttons on the page. Then
  48 either type the [_hint_ or the _text_][hint-chars] of a marked element to click
  49 it. This command has many variations, for example to copy links or open them in
  50 new tabs.
  51
  52 Search with <kbd>/</kbd> and cycle between matches with <kbd>n</kbd> and
  53 <kbd>N</kbd>.
  54
  55 Open a new tab with <kbd>t</kbd>, close it with <kbd>x</kbd>. Reopen it again
  56 with <kbd>X</kbd>. Switch between tabs with <kbd>J</kbd> and <kbd>K</kbd>, or
  57 some of the several other tab commands.
  58
  59 Scrolling left/down/up/right: <kbd>h</kbd>, <kbd>j</kbd>, <kbd>k</kbd>, <kbd>l</kbd>.
  60 Top/Bottom: <kbd>gg</kbd>, <kbd>G</kbd>.
  61 Page up/down: <kbd>space</kbd>, <kbd>shift-space</kbd>.
  62 Half a page: <kbd>d</kbd>, <kbd>u</kbd>.
  63
  64 Use [Caret mode] to copy text without using the mouse.
  65
  66 There are of course many more shortcuts! Press <kbd>?</kbd> to see them all, and
  67 then <kbd>/</kbd> to search among them. Click on a command or open VimFx’s
  68 [options] page in the Add-ons Manager to customize the [default shortcuts].
  69
  70 You can temporarily disable VimFx by using Ignore mode. Press <kbd>i</kbd> to
  71 enter it, and <kbd>shift-escape</kbd> to exit. Use the [blacklist] to
  72 automatically enter Ignore mode on specific sites.
  73
  74 There’s also an [article on ghacks.net][ghacks] which is a good introduction.
  75
  76 [hint-chars]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/options.md#hint-characters
  77 [Caret mode]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/commands.md#the-v-commands--caret-mode
  78 [options]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/options.md
  79 [default shortcuts]: https://github.com/akhodakivskiy/VimFx/blob/master/extension/lib/defaults.coffee
  80 [blacklist]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/options.md#blacklist
  81 [ghacks]: http://www.ghacks.net/2016/07/01/vimfx-improve-firefox-keyboard-use/
  82
  83 ## Feedback
  84
  85 Enjoying VimFx? [Write a review][review]!
  86
  87 Having a problem? Report it in the [issue tracker]!
  88
  89 [review]: https://addons.mozilla.org/firefox/addon/vimfx/reviews/add
  90 [issue tracker]: https://github.com/akhodakivskiy/VimFx/issues