Wiki

Clone wiki

Vimbin / Home

Vimbin

An easy to use repository for Vim plugins. Vimbin is built on Django 1.1.1

Vimbin is currently pre-alpha - it really doesn't do much of anything at the moment.

Getting Started

Dependencies are listed in requirements.txt, and can be automatically install using pip:

$ pip install -r requirements.txt

Virtualenv, and virtualenvwrapper are highly recommended as well

You'll need to set up some Akismet and email settings or certain parts of Vimbin, like user registration and comment submission, will fail. These should be set in local_settings.py. For convenience, a local settings template is included in the repository. Complete the template with the proper settings, and then rename the file to local_settings.py

For more information on running Vimbin on your PC, please see the TestDrive page.

Goals

Vim is a popular text editor with a very large community and thousands of available plugins. Unfortunately, the central clearinghouse for these plugins -- http://www.vim.org/scripts/index.php -- is extremely basic and lacks many useful features such as user reviews, searchable metadata, social features, etc.

The users of Vim can benefit greatly from a community website more akin to Mozilla's add-on site for Firefox (https://addons.mozilla.org/en-US/firefox/). In particular, the following features of Mozilla's site would directly translate into a potential Vim plugin site:

  • "Reviews" section allows users to rate each plugin (on a 1 to 5 star scale) and add comments
  • "Categories" drop-down allows users to browse plugins in many different categories and see the most popular in each
  • Screenshots are provided for most plugins and hosted on Mozilla's site instead of having to be linked externally via <img> tabs
  • "Share This" button allows one-click posting to Facebook, Delicious, etc.
  • "Collections" (https://addons.mozilla.org/en-US/firefox/collections/) allow users to create custom bundles of plugins either for sharing or backing up their own configuration
  • "Advanced Search" allows users to search by keyword, type, version, last updated, etc.
  • "Source Code License" section allows plugin authors to specify a particular license for their contribution

Some additional features that would be nice but not essential:

  • "Browse source" function to allow users to see the source code before downloading
  • "Theme browser" to preview any color schemes on a simulated Vim screen before downloading
  • User-assigned tags to provide additional metadata for each plugin
  • More sophisticated statistics on how many times the plugin was downloaded on a particular day, within the past month, etc.

Wiki Editing

This wiki uses the Creole syntax, and is fully compatible with the 1.0 specification.

The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.

Go ahead and try:

$ hg clone http://bitbucket.org/chrislawlor/vimbin/wiki/

Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.

Syntax highlighting

You can also highlight snippets of text, we use the excellent Pygments library.

Here's an example of some Python code:

def wiki_rocks(text):
	formatter = lambda t: "funky"+t
	return formatter(text)

You can check out the source of this page to see how that's done, and make sure to bookmark the vast library of Pygment lexers, we accept the 'short name' or the 'mimetype' of anything in there.

Have fun!

Updated