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