index

Installation

The easiest way to install Nvim is to use pathogen:

cd ~/.vim/bundle && git clone git://github.com/cwoac/nvim.git

Or if you manage things yourself, copy nvim.vim into your ~/.vim/plugins directory.

Script

NVim is not intended to be used in every vim session you open; to this end it will not be activated until you :call NVIM_init()

There is a supplied script nvim which will open vim and call this to drop you directly into nvim mode; simply copy it to somewhere on your path

Windows

(g)vim under windows looks in $HOME/vimfiles/ rather than ~/.vim for its files. Apart from that (and the fact that the nvim script won’t work, it should work identically under windows as linux - assuming you have got the requirements installed correctly.

Basic usage

I’ve made a quick screencast here outlining basic usage.

Either load vim and use the sequence \ <F5> or run nvim from the directory you want to store your notes in. You will be presented with two windows - on the right is the main pane where the note is displayed; on the left the list of search results. The first line of the search box is the current search term.

Use [[ to trigger vim’s auto-complete with the list of available titles.

nvim binds several keys, all combos are started with the user’s defined <leader> key. If you haven’t changed this, then it is \ by default.

Note that if you try an load a note that does not exist, the system will create a new one.

The full range of vim commands are available to you, but there are a couple of things to bear in mind:

Importing

If you have a bunch of notes already, then execute the following command to import them :python nvimdb.rebuild_database().

Configuration

configuration is handled at the top of nvim.vim. The main one is the extension for notes. By default, nvim uses .md and will ignore files with any other extension.