README.md

   1 # VimFx – Vim keyboard shortcuts for Firefox
   2
   3 **Note:** VimFx is a _legacy_ Firefox extension, which is **not**  [compatible
   4 with Firefox 57+][firefox-57+]. (And never will be.)
   5
   6 If you’re looking for a replacement for VimFx, check out these extensions:
   7
   8 - [Vimium-FF]
   9 - [Saka Key]
  10 - [Vim Vixen]
  11 - [Tridactyl]
  12
  13 You might also want to check out how to [patch Firefox to work with VimFx] and
  14 its accompanying [blog post].
  15
  16 (VimFx won’t be transformed into a WebExtension, because it is a big task that
  17 nobody has felt like tackling and not all necessary APIs are available. However,
  18 the source code is free, so if you feel like giving it a shot you can totally do
  19 so!)
  20
  21 [firefox-57+]: https://support.mozilla.org/en-US/kb/firefox-add-technology-modernizing
  22 [Vimium-FF]: https://addons.mozilla.org/firefox/addon/vimium-ff/
  23 [Saka Key]: https://addons.mozilla.org/firefox/addon/saka-key/
  24 [Vim Vixen]: https://addons.mozilla.org/firefox/addon/vim-vixen/
  25 [Tridactyl]: https://addons.mozilla.org/firefox/addon/tridactyl-vim/
  26 [patch Firefox to work with VimFx]: https://github.com/girst/LegacyFox
  27 [blog post]: https://gir.st/blog/legacyfox.htm
  28
  29 ---
  30
  31 <img src="extension/skin/icon128.png" alt="" align="right">
  32
  33 VimFx is a Firefox extension which adds short, Vim-style keyboard shortcuts
  34 for browsing and navigation, for a near mouseless experience.
  35
  36 - Doesn’t change your browser in any way. Everything can be disabled.
  37 - Easy for beginners, powerful for advanced users. Not just for Vim fanatics.
  38 - Modeled after [Vimium] for Chrome.
  39
  40 **New to VimFx?** Check out [Questions & Answers]!
  41 Power user? Make a [config file]!
  42 In either case, have look at the the [documentation] and the [wiki].
  43
  44 VimFx is made by [these awesome people][people].
  45
  46 [Vimium]: http://vimium.github.io/
  47 [Vimperator]: http://www.vimperator.org/vimperator
  48 [config file]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/config-file.md
  49 [documentation]: https://github.com/akhodakivskiy/VimFx/tree/master/documentation#contents
  50 [wiki]: https://github.com/akhodakivskiy/VimFx/wiki
  51 [Questions & Answers]: https://github.com/akhodakivskiy/VimFx/tree/master/documentation/questions-and-answers.md
  52 [people]: https://github.com/akhodakivskiy/VimFx/blob/master/PEOPLE.md
  53
  54 ## Why VimFx was created
  55
  56 > Even before [Vimium] there was [Vimperator] for Firefox. In my opinion,
  57 > Vimperator has too many features and aggressively changes the default Firefox
  58 > appearance and behavior. Vimium is exactly what I need in terms of added
  59 > functionality, but for Chrome. That’s why I decided to develop a similar
  60 > extension for Firefox.
  61 >
  62 > &nbsp;**VimFx will be nice to your browser and to your habits. Promise.**
  63 >
  64 > – _Anton Khodakivskiy,_ VimFx’s original author.
  65
  66 ## Key Features
  67
  68 VimFx has concise shortcuts for most commonly performed actions. Many simply
  69 invoke standard Firefox features. That is preferred over re-implementing similar
  70 functionality.
  71
  72 Press <kbd>f</kbd> to mark links, text inputs and buttons on the page. Then
  73 either type the [_hint_ or the _text_][hint-chars] of a marked element to click
  74 it. This command has many variations, for example to copy links or open them in
  75 new tabs.
  76
  77 Search with <kbd>/</kbd> and cycle between matches with <kbd>n</kbd> and
  78 <kbd>N</kbd>.
  79
  80 Open a new tab with <kbd>t</kbd>, close it with <kbd>x</kbd>. Reopen it again
  81 with <kbd>X</kbd>. Switch between tabs with <kbd>J</kbd> and <kbd>K</kbd>, or
  82 some of the several other tab commands.
  83
  84 Scrolling left/down/up/right: <kbd>h</kbd>, <kbd>j</kbd>, <kbd>k</kbd>, <kbd>l</kbd>.
  85 Top/Bottom: <kbd>gg</kbd>, <kbd>G</kbd>.
  86 Page up/down: <kbd>space</kbd>, <kbd>shift-space</kbd>.
  87 Half a page: <kbd>d</kbd>, <kbd>u</kbd>.
  88
  89 Use [Caret mode] to copy text without using the mouse.
  90
  91 There are of course many more shortcuts! Press <kbd>?</kbd> to see them all, and
  92 then <kbd>/</kbd> to search among them. Click on a command or open VimFx’s
  93 [options] page in the Add-ons Manager to customize the [default shortcuts].
  94
  95 You can temporarily disable VimFx by using Ignore mode. Press <kbd>i</kbd> to
  96 enter it, and <kbd>shift-escape</kbd> to exit. Use the [blacklist] to
  97 automatically enter Ignore mode on specific sites.
  98
  99 There’s also an [article on ghacks.net][ghacks] which is a good introduction.
 100
 101 [hint-chars]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/options.md#hint-characters
 102 [Caret mode]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/commands.md#the-v-commands--caret-mode
 103 [options]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/options.md
 104 [default shortcuts]: https://github.com/akhodakivskiy/VimFx/blob/master/extension/lib/defaults.coffee
 105 [blacklist]: https://github.com/akhodakivskiy/VimFx/blob/master/documentation/options.md#blacklist
 106 [ghacks]: http://www.ghacks.net/2016/07/01/vimfx-improve-firefox-keyboard-use/