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