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