README.md

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