README.md

   1 # VimFx – Vim keyboard shortcuts for Firefox
   2
   3 <img src="icon-large.png" alt="" align="right">
   4
   5 [VimFx] is a [Mozilla Firefox] extension which adds Vim-style keyboard shortcuts
   6 for browsing and navigation, significantly reducing the use of the mouse, and
   7 allowing your hands to rest on the home row.
   8
   9 VimFx was inspired by [Vimperator] and designed after [Vimium] for [Google
  10 Chrome], preserving the shortcuts and behavior. If you are used to Vimium then
  11 it will be easy to get started with VimFx.
  12
  13 **Mailing list:** [vimfx@librelist.com] (just send an email to subscribe)
  14
  15 Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening issues and pull requests.
  16
  17 VimFx is made by [these awesome people](PEOPLE.md).
  18
  19 [vimfx@librelist.com]: mailto:vimfx@librelist.com?subject=Subscribe
  20 [VimFx]: https://addons.mozilla.org/firefox/addon/vimfx
  21 [Mozilla Firefox]: https://www.mozilla.org/firefox
  22 [Vimperator]: http://www.vimperator.org/vimperator
  23 [Vimium]: http://vimium.github.io/
  24 [Google Chrome]: https://www.google.com/chrome
  25
  26 ## Why VimFx was created
  27
  28 > Even before Vimium there was Vimperator for Firefox. In my opinion the problem
  29 > with Vimperator is that it has too many features and aggressively changes the
  30 > default Firefox appearance and behavior. Vimium was developed for Google Chrome
  31 > and it was exactly what I needed in terms of added functionality. That's why I
  32 > decided to develop similar extension for Firefox.
  33 >
  34 > VimFx will be nice to your browser and to your habits. Promise.
  35 >
  36 > <footer>– <cite>Anton Khodakivskiy</cite>, VimFx’s original author.</footer>
  37
  38 ## Key Features
  39
  40 - Concise shortcuts for most commonly performed actions.
  41 - Follow links, focus text inputs and click buttons on the page using hint
  42   markers.
  43 - Easily accessible help dialog for the keyboard shortcuts.
  44 - Every keyboard shortcut is customizable.
  45 - Prefers native Firefox features over re-implementing similar functionality.
  46
  47 ## Shortcuts
  48
  49 This is a text representation of the keyboard shortcuts dialog within the
  50 extension, which helps you remember the shortcuts, and lets you customize them.
  51 Press <kbd>?</kbd> or use the toolbar button to open it.
  52
  53 ### Dealing with URLs
  54
  55     o            Focus the Address Bar
  56     O            Focus the Search Bar
  57     p            Paste and go
  58     P            Paste and go in a new tab
  59     yf           Copy link url to the clipboard
  60     vf           Focus element
  61     yy           Copy link or text input value
  62     r            Reload
  63     R            Reload (override cache)
  64     ar           Reload all tabs
  65     aR           Reload all tabs (override cache)
  66     s            Stop loading the page
  67     as           Stop loading all tabs
  68
  69 ### Navigating the Page
  70
  71     gg           Scroll to top
  72     G            Scroll to bottom
  73     j            Scroll down
  74     k            Scroll up
  75     h            Scroll left
  76     l            Scroll right
  77     d            Scroll half a page down
  78     u            Scroll half a page up
  79     <space>      Scroll full page down
  80     <s-space>    Scroll full page up
  81
  82 ### Working with Tabs
  83
  84     t            New tab
  85     J  gT        Previous tab
  86     K  gt        Next tab
  87     gJ           Move tab left
  88     gK           Move tab right
  89     gh           Go to the Home Page
  90     gH  g0       Go to the first tab
  91     g^           Go to the first non-pinned tab
  92     gL  g$       Go to the last tab
  93     gp           Pin/Unpin tab
  94     yt           Duplicate tab
  95     gx$          Close tabs to the right
  96     gxa          Close other tabs
  97     x            Close tab
  98     X            Restore closed tab
  99
 100 ### Browsing
 101
 102     f            Follow link, focus text input or click button
 103     F            Follow link in a new tab
 104     af           Follow a link on the current page in a new tab
 105     [            Go to the next page
 106     ]            Go to the previous page
 107     gu           Go up one level in the URL
 108     gU           Go to root in the URL
 109     H            Go back in history
 110     L            Go forward in history
 111
 112 ### Misc
 113
 114     /            Enter Find mode
 115     a/           Enter Find mode highlighting all matches
 116     n            Find next
 117     N            Find previous
 118     i            Enter insert mode: Ignore all commands
 119     I            Pass next keypress through to the page
 120     ?            Show this dialog
 121     :            Open the Developer Toolbar
 122     <escape>     Blur/close active element
 123
 124 ### Hints Mode
 125
 126     <escape>     Return to normal mode
 127     <space>      Rotate overlapping markers forward
 128     <s-space>    Rotate overlapping markers backward
 129     <backspace>  Delete last typed hint character
 130
 131 ### Insert Mode
 132
 133     <s-escape>   Return to normal mode
 134
 135 ### Find Mode
 136
 137     <escape> <return> Close find bar