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       Scroll half a Page Down
  55     u       Scroll half a Page Up
  56     c-f     Scroll a full page Down
  57     c-b     Scroll a full page Up
  58
  59 ### Tabs
  60
  61     t       Open New Blank tab
  62     J gT    Go to the Previous tab
  63     K gt    Go to the Next tab
  64     c-J     Move current tab to the Left
  65     c-K     Move current tab to the Right
  66     gH g0   Go to the First tab
  67     gL g$   Go to the Last tab
  68     x       Close current tab
  69     X       Restore last closed tab
  70
  71 ### Browsing
  72
  73     f       Follow a link on the current page
  74     F       Follow a link on the current page in a new tab
  75     H       Go Back in history
  76     L       Go Forward in history
  77
  78 ### Misc
  79
  80     ?       Show Help Dialog
  81     Esc     Close this dialog and cancel hint markers
  82
  83 ## Release Notes
  84
  85 0.1 (26 Oct 2012)
  86
  87 - Initial Release
  88
  89 0.1.1 (27 Oct 2012)
  90
  91 - Just to deal with AMO - no changes
  92
  93 0.2 (5 Nov 2012)
  94
  95 - document.designMode='on' is now honored. Will also provide hint markers for iframes on the page.
  96 - Bug fixed where it would completely reset the toolbar while installing the toolbar button.
  97 - Bug fixed where it's not possible to change the text in the blaclisting textbox
  98 - Changed u/d to scroll half a page, added ^f/^b to scroll full page
  99 - Added tab movement commands: ^J and ^K.
 100 - Invisible markers bug fixed.
 101 - Global hotkey to disable the commands (equal to the toolbar button click): Alt-Shift V
 102 - ^u and ^d are removed from the command list. ^u is commonly used to show the page source code
 103 - Opening new tab with now focuses the Address Bar
 104 - Other small bugs nailed down.