README.md

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