README.md

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