documentation/README.md

   1 # VimFx documentation
   2
   3 ## Contents
   4
   5 - [Questions & Answers](questions-and-answers.md)
   6   **– New to VimFx? Look here!**
   7
   8 - [Install VimFx](installation.md)
   9   – Click a button or build it from source.
  10
  11 - [Options](options.md)
  12   – All of VimFx’s _options_ listed and explained in one place.
  13
  14 - [Styling](styling.md)
  15   – Customize the looks of VimFx, such as hint marker font size.
  16
  17 - [Modes](modes.md)
  18   – An introduction to VimFx’s _modes._
  19
  20 - [Commands](commands.md)
  21   – Extra details about some of VimFx’s _commands._
  22
  23 - [Shortcuts](shortcuts.md)
  24   – How the keyboard _shortcuts_ for commands work.
  25
  26 - [Button](button.md)
  27   – Details of VimFx’s toolbar button. ![button-icon]
  28
  29 - [Notifications](notifications.md)
  30   – How VimFx sometimes talks to you.
  31
  32 - [Handy standard Firefox features](handy-standard-firefox-features.md)
  33   – Tips and tricks that are standard Firefox stuff, but very useful to VimFx.
  34
  35 - [Known Bugs](known-bugs.md)
  36   – A list of known deficiencies and how to work around them.
  37
  38 Also check out the [wiki](https://github.com/akhodakivskiy/VimFx/wiki)!
  39
  40 [button-icon]: ../extension/skin/icon16.png
  41
  42 ### For advanced users
  43
  44 - [Config file](config-file.md)
  45   – Add custom commands and customize VimFx using a text file.
  46
  47 - [API](api.md)
  48   – The API available for config files.
  49
  50 ### For contributors
  51
  52 - [Contributing code](CONTRIBUTING-CODE.md)
  53   – How to, and tips for getting your pull request merged faster.
  54
  55 - [Tools](tools.md)
  56   – Automation for building and maintaining VimFx.