README.md

   1 # VimFx - Vim keyboard shortcuts for Firefox
   2
   3 *Extension AMO page*: https://addons.mozilla.org/en-US/firefox/addon/vimfx/
   4
   5 [VimFx](https://addons.mozilla.org/en-US/firefox/addon/vimfx/)
   6 is a [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/fx/#desktop)
   7 extension which introduces Vim-style keyboard shortcuts for browsing and navigation,
   8 significantly reducing the use of mouse, and allowing your hands to rest on the home row.
   9
  10 VimFx was inspired by [Vimperator](http://www.vimperator.org/)
  11 and designed after [Vimium](http://vimium.github.com/) for
  12 [Google Chrome](https://www.google.com/intl/en/chrome/browser/) preserving the shortcuts and behavior.
  13 If your are used to Vimium then it will be easy to get started with VimFx.
  14
  15 ## Why VimFx was created
  16
  17 Even before Vimium there was Vimperator for Firefox.  In my opinion the problem
  18 with Vimperator is that it has too many features and aggressively changes
  19 the default Firefox appearance and behavior. Vimium was developed for Google Chrome
  20 and it was exactly what I needed in terms of added functionality. That's why I decided
  21 to develop similar extension for Firefox.
  22
  23 VimFx will be nice to your browser and to your habits. Promise.
  24
  25 ## Credits
  26
  27
  28
  29 ## Key Features
  30
  31 - Concise shortcuts for most commonly performed actions
  32 - Follow and access controls on the page using hint markers
  33 - Easy access to the Help page which describes all available shortcuts (press ?)
  34
  35 ## Shortcuts
  36
  37 Might not be up to date. Please refer to the Help dialog withing the extension
  38 for the most relevant list.
  39
  40 Global shortcut to enable/disable VimFx: `Shift-Alt-v`
  41
  42 ### URLs
  43
  44     p       Navigate to the address in the clipboard
  45     P       Open new tab and navigate to the address in the clipboard
  46     yf      Copy link url to the clipboard
  47     yy      Copy current page link to the clipboard
  48     r       Reload current page
  49     R       Reload current page and all the assets (js, css, etc.)
  50
  51 ### Navigating
  52
  53     gg      Scroll to the Top of the page
  54     G       Scroll to the Bottom of the page
  55     j c-e   Scroll Down
  56     k c-y   Scroll Up
  57     h       Scroll Left
  58     l       Scroll Right
  59     d       Scroll half a Page Down
  60     u       Scroll half a Page Up
  61
  62 ### Tabs
  63
  64     t       Open New Blank tab
  65     J gT    Go to the Previous tab
  66     K gt    Go to the Next tab
  67     c-J     Move current tab to the Left
  68     c-K     Move current tab to the Right
  69     gH g0   Go to the First tab
  70     gL g$   Go to the Last tab
  71     x       Close current tab
  72     X       Restore last closed tab
  73
  74 ### Browsing
  75
  76     f       Follow a link on the current page
  77     F       Follow a link on the current page in a new tab
  78     H       Go Back in history
  79     L       Go Forward in history
  80
  81 ### Misc
  82
  83     ?       Show Help Dialog
  84     Esc     Close this dialog and cancel hint markers
  85
  86 ## Release Notes
  87
  88 0.1 (26 Oct 2012)
  89
  90 - Initial Release
  91
  92 0.1.1 (27 Oct 2012)
  93
  94 - Just to deal with AMO - no changes
  95
  96 0.2 (5 Nov 2012)
  97
  98 - document.designMode='on' is now honored. Will also provide hint markers for iframes on the page.
  99 - Bug fixed where it would completely reset the toolbar while installing the toolbar button.
 100 - Bug fixed where it's not possible to change the text in the blaclisting textbox
 101 - Changed u/d to scroll half a page, added ^f/^b to scroll full page
 102 - Added tab movement commands: ^J and ^K.
 103 - Invisible markers bug fixed.
 104 - Global hotkey to disable the commands (equal to the toolbar button click): Alt-Shift V
 105 - ^u and ^d are removed from the command list. ^u is commonly used to show the page source code
 106 - Opening new tab with now focuses the Address Bar
 107 - Other small bugs nailed down.
 108
 109 0.3 (19 Nov 2012)
 110
 111 - Fixed [Desktop](https://addons.mozilla.org/en-us/firefox/addon/desktop/) extension compatibility problem
 112 - Removed c-b/c-f for now. c-f is a standard search hotkey. Will put c-f back when proper Vim-like search with / is implemented
 113 - Scrolling with G will now reach the bottom of the page
 114 - Implemented localization, currently there is only Russian localization. Community is welcome
 115   [to contribute your localizations](https://github.com/akhodakivskiy/VimFx/tree/master/extension/locale)!
 116 - Implemented simple smooth scolling