Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Take Notes in rst.
VimL CSS Python TeX


Riv: Take Notes in rst

Join the chat at
Last Update:2014-11-07

The Internet is just a world passing around notes in a classroom.

Jon Stewart

What's New

As The clickable is not stable. And with many voting to disable it.

I revert to 0.77.

There are other features should be done in this version 0.79.

But I don't have enough time currently.

But You can give me advice here too.

And any advice for 0.8 is welcome.


Both bug reports and suggestions are welcome.

Many Thanks!


Riv is a vim plugin for taking notes with reStructuredText.

riv.vim (vim) + InstantRst (web server) + rhythm.css (theme)


First things first.

As there are some other note plugins in vim. like vimwiki, vim-notes, VOoM etc.

Also org-mode if you are Emacs fan.

Why using this plugin?

In comparition, the most advantage of Riv.vim is reStructuredText support.

reStructuredText is a markup language.

It's syntax are markdown alike, but more powerful and extensible, table, LaTex ect. are supported.

It's widely used in python community. And have many relevent plugins. Sphinx ( Pygments, Nikola, etc.

There is a post of comparions between reStructuredText and markdown


Write wiki with project and file link support. TODO syntax is added.
Faster typing, easier navigation, clear intending, auto formatting etc.
Improved syntax highlighting and folding support for reading document clearly.
Convert rst files to a number of different formats: pdf, html, xml, latex and odt etc. A new theme rhythm.css is added for better performance.

Support many plugins like Sphinx syntax support. Other rst plugins:

Contribution to this list are welcome.


Using Vundle

Recommended Add this line to your .vimrc (after you have properly set up Vundle):

Bundle 'Rykka/riv.vim'

Downloaded zip/tar.gz file

Extract the contents of the archive to your .vim directory.


You can add projects with g:riv_projects:

let proj1 = { 'path': '~/Dropbox/rst',}
let g:riv_projects = [proj1]

More options see the :RivInstruction

Make sure your .vim directory is before $VIMRUNTIME in runtimepath. By default it IS present before $VIMRUNTIME.

Also Make sure filetype plugin indent on and syntax on options are present in your .vimrc.

Related tools


You can have a quick start with :RivQuickStart.

Here is the Screencast:

New To Vim

  • If you are new to Vim, you can get a basic overview of Vim using vimtutor. To use it simply type vimtutor in your shell.
  • To view the quick reference of Vim, use :h quickref.

New TO Rst

New To Riv

  • For getting started with Riv, read "QuickStart With Riv". You can also view it using :RivQuickStart in Vim.
  • Detailed instructions for Riv are available at "Instructions". Use :RivInstruction to read the same in Vim.


The bug tracker for Riv is at You can use it to report bugs and open feature requests. Discussions related to Riv are welcome too.

You can follow my twitter @rykkaf and notice me there too.

Common Issues

  • If you get errors with folding in documents, you can try to force reload using :RivReload or <C-E>t`.

    Or just :w as it will auto refolding after saving.

  • Windows:

    • Converting to other formats may fail.

      This could happen due to Docutils not working correctly with vimrun.exe.

  • Mac OS:

    • Lists don't act as expected.

      This could happen if the <C-Enter> key could not be mapped. Try some other mapping instead.

Something went wrong with that request. Please try again.