addons/taglist-plus/README.md

   1 taglist-plus.vim
   2 ================
   3
   4 This is a fork of the popular taglist.vim plugin.
   5
   6 Taglist-plus provides excellent Javascript support via jsctags. See [here][1]
   7 for examples.
   8
   9 This plugin can also be obtained through [vim.org][2].
  10
  11 Installation
  12 ------------
  13
  14 Unzip the plugin files to your `.vim` directory.
  15
  16 For great Javascript support, jsctags is required as well.
  17
  18 jsctags can be obtained via [github][4]. It requires a recent version of
  19 node.js -- the default one provided in Maverick Meerkat won't cut it. You can
  20 [build it from source][6] or get it via [this PPA][5].
  21
  22 If you're going the PPA route, you'll need to map `nodejs` to `node`. Here are
  23 the commands:
  24 <pre>
  25 sudo add-apt-repository ppa:richarvey/nodester
  26 sudo apt-get update
  27 sudo apt-get install nodejs
  28 sudo ln -s /usr/bin/nodejs /usr/local/bin/node
  29 </pre>
  30
  31 Usage
  32 -----
  33
  34 `:TlistToggle` brings up the taglist window.  More commands can be found via
  35 `:help taglist-commands`.
  36
  37 [1]:http://discontinuously.com/2011/03/vim-support-javascript-taglist-plus/
  38 [2]:https://github.com/int3/vim-taglist-plus
  39 [3]:http://www.vim.org/scripts/script.php?script_id=3504
  40 [4]:https://github.com/mozilla/doctorjs
  41 [5]:https://launchpad.net/~richarvey/+archive/nodester
  42 [6]:http://nodejs.org/#download