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