README.md

   1 # VimFx - Vim keyboard shortcuts for Firefox
   2
   3 VimFx is a [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/fx/#desktop)
   4 extension which introduces Vim-style keyboard shortcuts for browsing and navigation,
   5 significantly reducing the use of mouse, and allowing your hands to rest on the home row.
   6
   7 VimFx was inspired by [Vimperator](http://www.vimperator.org/)
   8 and designed after [Vimium](http://vimium.github.com/) for
   9 [Google Chrome](https://www.google.com/intl/en/chrome/browser/) preserving the shortcuts and behavior.
  10 If your are used to Vimium then it will be easy to get started with VimFx.
  11
  12 ## Why VimFx was created
  13
  14 Even before Vimium there was Vimperator for Firefox.  In my opinion the problem
  15 with Vimperator is that it has too many features and aggressively changes
  16 the default Firefox appearance and behavior. Vimium was developed for Google Chrome
  17 and it was exactly what I needed in terms of added functionality. That's why I decided
  18 to develop similar extension for Firefox.
  19
  20 VimFx will be nice to your browser and to your habits. Promise.
  21
  22 ## Credits
  23
  24
  25
  26 ## Key Features
  27
  28 - Concise shortcuts for most commonly performed actions
  29 - Follow and access controls on the page using hint markers
  30 - Easy access to the Help page which describes all available shortcuts (press ?)
  31
  32 ## Shortcuts
  33
  34 Might not be up to date. Please refer to the Help dialog withing the extension
  35 for the most relevant list.
  36
  37 ### URLs
  38
  39     p       Navigate to the address in the clipboard
  40     P       Open new tab and navigate to the address in the clipboard
  41     yf      Copy link url to the clipboard
  42     yy      Copy current page link to the clipboard
  43     r       Reload current page
  44     R       Reload current page and all the assets (js, css, etc.)
  45
  46 ### Navigating
  47
  48     gg      Scroll to the Top of the page
  49     G       Scroll to the Bottom of the page
  50     j c-e   Scroll Left
  51     k c-y   Scroll Right
  52     h       Scroll Down
  53     l       Scroll Up
  54     d c-d   Scroll a Page Down
  55     u c-u   Scroll a Page Up
  56
  57 ### Tabs
  58
  59     t       Open New Blank tab
  60     J gT    Go to the Previous tab
  61     K gt    Go to the Next tab
  62     gH g0   Go to the First tab
  63     gL g$   Go to the Last tab
  64     x       Close current tab
  65     X       Restore last closed tab
  66
  67 ### Browsing
  68
  69     f       Follow a link on the current page
  70     F       Follow a link on the current page in a new tab
  71     H       Go Back in history
  72     L       Go Forward in history
  73
  74 ### Misc
  75
  76     ?       Show Help Dialog
  77     Esc     Close this dialog and cancel hint markers
  78
  79 ## Release Notes
  80
  81 0.1 (26 Oct 2012)
  82
  83 - Initial Release
  84