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 **Mailing list**: [vimfx@librelist.com](mailto:vimfx@librelist.com?subject=Subscribe) (just send an email to subscribe)
   6
   7 Contribute your localization! See `locale` folder.
   8
   9 Read [Contributing and Reporting Issues section](#contributing-and-reporting-issues) for tips.
  10 > Tl;dr: Pull request to the **develop** branch! Issues in **English**!
  11
  12 ## Overview
  13
  14 [VimFx](https://addons.mozilla.org/en-US/firefox/addon/vimfx/)
  15 is a [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/fx/#desktop)
  16 extension which introduces Vim-style keyboard shortcuts for browsing and navigation,
  17 significantly reducing the use of mouse, and allowing your hands to rest on the home row.
  18
  19 VimFx was inspired by [Vimperator](http://www.vimperator.org/)
  20 and designed after [Vimium](http://vimium.github.com/) for
  21 [Google Chrome](https://www.google.com/intl/en/chrome/browser/) preserving the shortcuts and behavior.
  22 If your are used to Vimium then it will be easy to get started with VimFx.
  23
  24 ## Why VimFx was created
  25
  26 Even before Vimium there was Vimperator for Firefox.  In my opinion the problem
  27 with Vimperator is that it has too many features and aggressively changes
  28 the default Firefox appearance and behavior. Vimium was developed for Google Chrome
  29 and it was exactly what I needed in terms of added functionality. That's why I decided
  30 to develop similar extension for Firefox.
  31
  32 VimFx will be nice to your browser and to your habits. Promise.
  33
  34 ## Key Features
  35
  36 - Concise shortcuts for most commonly performed actions
  37 - Follow and access controls on the page using hint markers
  38 - Easy access to the Help page which describes all available shortcuts (press ?)
  39
  40 ## Shortcuts
  41
  42 Might not be up to date. Please refer to the Help dialog withing the extension
  43 for the most relevant list.
  44
  45 Global shortcut to enable/disable VimFx: `Shift-Alt-v`
  46
  47 ### URLs
  48
  49     o       Focus the Address 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
  60 ### Navigating
  61
  62     gg      Scroll to the Top of the page
  63     G       Scroll to the Bottom of the page
  64     j,c-e   Scroll Down
  65     k,c-y   Scroll Up
  66     h       Scroll Left
  67     l       Scroll Right
  68     d       Scroll half a Page Down
  69     u       Scroll half a Page Up
  70     c-f     Scroll full Page Down
  71     c-b     Scroll full Page Up
  72
  73 ### Tabs
  74
  75     t       Open New Blank tab
  76     J,gT    Go to the Previous tab
  77     K,gt    Go to the Next tab
  78     c-J     Move current tab to the Left
  79     c-K     Move current tab to the Right
  80     gh      Navigate to the Home Page
  81     gH,g0   Go to the First tab
  82     gL,g$   Go to the Last tab
  83     x       Close current tab
  84     X       Restore last closed tab
  85
  86 ### Browsing
  87
  88     f       Follow a link on the current page
  89     F       Follow a link on the current page in a new tab
  90     H       Go Back in history
  91     L       Go Forward in history
  92
  93 ### Misc
  94
  95     .,/     Enter Find mode
  96     a.,a/   Enter Find mode to highlight all matches
  97     n       Go to the next Find match
  98     N       Go to the previous Find match
  99     ?,>     Show Help Dialog
 100     Esc     Close this dialog and cancel hint markers
 101
 102 ## Contributing and Reporting Issues
 103
 104 1. Fork.
 105 2. Clone.
 106 3. Checkout the **develop** branch: `git checkout develop`
 107 4. Create a new branch (using develop as base): `git checkout -b myTopicBranch`
 108    Using develop (and not master) as base makes it easier to pull request to develop when you're done.
 109 5. Code! Try to follow the style of the rest of the code. There are no written rules (yet?).
 110 6. Push your branch to your fork on GitHub.
 111 7. Pull request to the **develop** branch.
 112
 113 ### Tips:
 114
 115 - Compile the .coffee files with the **`--bare`** option! Otherwise you will get errors.
 116 - Run `coffee -cbw .` from the root of the project to automatically compile on changes.
 117 - Put a file called exactly `VimFx@akhodakivskiy.github.com` in the extensions/ folder of a Firefox
 118   profile, containing the absolute path to the extension/ folder in the project. Then you just need
 119   to restart Firefox (use some add-on!) after each change. More details in [this MDN article][mdn-extdevenv].
 120 - Only create tickets for issues and feature requests in English. Otherwise duplicate
 121   tickets in different languages will pile up.
 122
 123 [mdn-extdevenv]: https://developer.mozilla.org/en-US/docs/Setting_up_extension_development_environment#Firefox_extension_proxy_file