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            Paste and go
  51     P            Paste and go in a new tab
  52     yf           Copy link url to the clipboard
  53     vf           Focus element
  54     yy           Copy link or text input value
  55     r            Reload
  56     R            Reload (override cache)
  57     ar           Reload all tabs
  58     aR           Reload all tabs (override cache)
  59     s            Stop loading the page
  60     as           Stop loading all tabs
  61
  62 ### Navigating the Page
  63
  64     gg           Scroll to top
  65     G            Scroll to bottom
  66     j            Scroll down
  67     k            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     <space>      Scroll full page down
  73     <s-space>    Scroll full page up
  74
  75 ### Working with Tabs
  76
  77     t            New tab
  78     J  gT        Previous tab
  79     K  gt        Next tab
  80     gJ           Move tab left
  81     gK           Move tab right
  82     gh           Go to the Home Page
  83     gH  g0       Go to the first tab
  84     g^           Go to the first non-pinned tab
  85     gL  g$       Go to the last tab
  86     gp           Pin/Unpin tab
  87     yt           Duplicate tab
  88     gx$          Close tabs to the right
  89     gxa          Close other tabs
  90     x            Close tab
  91     X            Restore closed tab
  92
  93 ### Browsing
  94
  95     f            Follow link, focus text input or click button
  96     F            Follow link in a new tab
  97     af           Follow a link on the current page in a new tab
  98     [            Go to the next page
  99     ]            Go to the previous page
 100     gu           Go up one level in the URL
 101     gU           Go to root in the URL
 102     H            Go back in history
 103     L            Go forward in history
 104
 105 ### Misc
 106
 107     /            Enter Find mode
 108     a/           Enter Find mode highlighting all matches
 109     n            Find next
 110     N            Find previous
 111     i            Enter insert mode: Ignore all commands
 112     I            Pass next keypress through to the page
 113     ?            Show this dialog
 114     :            Open the Developer Toolbar
 115     <escape>     Blur/close active element
 116
 117 ### Hints Mode
 118
 119     <escape>     Return to normal mode
 120     <space>      Rotate overlapping markers forward
 121     <s-space>    Rotate overlapping markers backward
 122     <backspace>  Delete last typed hint character
 123
 124 ### Insert Mode
 125
 126     <c-escape>   Return to normal mode
 127
 128 ### Find Mode
 129
 130     <escape> <return> Close find bar