README.md

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