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