README.md

   1 # VimFx - Vim keyboard shortcuts for Firefox
   2
   3 ![VimFx Logo](icon-large.png)
   4
   5 **Extension AMO page**: <https://addons.mozilla.org/firefox/addon/vimfx>.
   6
   7 **Mailing list**: [vimfx@librelist.com] (just send an email to subscribe)
   8
   9 Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening issues and pull requests.
  10
  11 [vimfx@librelist.com]: mailto:vimfx@librelist.com?subject=Subscribe
  12
  13 ## Overview
  14
  15 [VimFx] is a [Mozilla Firefox] extension which adds Vim-style keyboard shortcuts
  16 for browsing and navigation, significantly reducing the use of the mouse, and
  17 allowing your hands to rest on the home row.
  18
  19 VimFx was inspired by [Vimperator] and designed after [Vimium] for [Google
  20 Chrome] preserving the shortcuts and behavior. If you are used to Vimium then
  21 it will be easy to get started with VimFx.
  22
  23 [VimFx]: https://addons.mozilla.org/firefox/addon/vimfx
  24 [Mozilla Firefox]: https://www.mozilla.org/firefox
  25 [Vimperator]: http://www.vimperator.org/vimperator
  26 [Vimium]: http://vimium.github.io/
  27 [Google Chrome]: https://www.google.com/chrome
  28
  29 ## Why VimFx was created
  30
  31 Even before Vimium there was Vimperator for Firefox. In my opinion the problem
  32 with Vimperator is that it has too many features and aggressively changes the
  33 default Firefox appearance and behavior. Vimium was developed for Google Chrome
  34 and it was exactly what I needed in terms of added functionality. That's why I
  35 decided to develop similar extension for Firefox.
  36
  37 VimFx will be nice to your browser and to your habits. Promise.
  38
  39 ## Key Features
  40
  41 - Concise shortcuts for most commonly performed actions.
  42 - Follow links, focus text inputs and click buttons on the page using hint
  43   markers.
  44 - Easily accessible help dialog for the keyboard shortcuts.
  45 - Every keyboard shortcut is customizable.
  46 - Prefers native Firefox features over re-implementing similar functionality.
  47
  48 ## Shortcuts
  49
  50 This is a text representation of the keyboard shortcuts dialog within the
  51 extension, which helps you remember the shortcuts, and lets you customize them.
  52 Press <kbd>?</kbd> or use the toolbar button to open it.
  53
  54 Global shortcut to enable/disable VimFx: `shift-alt-v`
  55
  56 ### Dealing with URLs
  57
  58     o       Focus the Address Bar
  59     O       Focus the Search Bar
  60     p       Navigate to the address in the clipboard
  61     P       Open new tab and navigate to the address in the clipboard
  62     yf      Copy link url to the clipboard
  63     vf      Focus element
  64     yy      Copy current page link to the clipboard
  65     r       Reload current page
  66     R       Reload current page and all the assets (js, css, etc.)
  67     ar      Reload pages in all tabs
  68     aR      Reload pages in all tabs including assets (js, css, img)
  69     s       Stop loading current page
  70     as      Stop loading pages in all tabs
  71
  72 ### Navigating the Page
  73
  74     gg      Scroll to the Top of the page
  75     G       Scroll to the Bottom of the page
  76     j,c-e   Scroll Down
  77     k,c-y   Scroll Up
  78     h       Scroll Left
  79     l       Scroll Right
  80     d       Scroll half a Page Down
  81     u       Scroll half a Page Up
  82     c-f     Scroll full Page Down
  83     c-b     Scroll full Page Up
  84
  85 ### Working with Tabs
  86
  87     t       Open New Blank tab
  88     J,gT    Go to the Previous tab
  89     K,gt    Go to the Next tab
  90     c-J     Move current tab to the Left
  91     c-K     Move current tab to the Right
  92     gh      Navigate to the Home Page
  93     gH,g^   Go to the First tab
  94     gL,g$   Go to the Last tab
  95     x       Close current tab
  96     X       Restore last closed tab
  97
  98 ### Browsing
  99
 100     f       Follow a link on the current page
 101     F       Follow a link on the current page in a new tab
 102     af      Follow multiple links on the current page
 103     [       Follow the Previous page link on the current page
 104     ]       Follow the Next page link on the current page
 105     gu      Go up one level in the URL hierarchy
 106     gU      Go up to root of the URL hierarchy
 107     H       Go Back in history
 108     L       Go Forward in history
 109
 110 ### Misc
 111
 112     /       Enter Find mode
 113     a/      Enter Find mode to highlight all matches
 114     n       Go to the next Find match
 115     N       Go to the previous Find match
 116     i       Enter insert mode: Ignore all commands
 117     ?       Show this dialog
 118     :       Open Developer Toolbar
 119     Esc     Enter normal mode (remove hint markers, exit insert mode) or blur/close active element
 120
 121 Can't see a link hint, because it's overlapped by another? Try pressing space or shift-space!