Skip to content
Notes and Wiki with rst.
Vim script CSS Python Other
Branch: master
Clone or download
Latest commit 87a1f2c Sep 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
after/syntax Merge branch 'master' of github.com:gu-fan/riv.vim Oct 17, 2018
autoload 0.793 #121 Feb 9, 2019
doc 0.793 #121 Feb 9, 2019
ftplugin/rst move func in ftplugin to autoload Oct 13, 2012
indent Merge branch 'master' of github.com:gu-fan/riv.vim Oct 17, 2018
plugin hard link README.rst to doc/riv.rst Sep 24, 2012
syntax
.gitignore add intro/ fix error viewing non-exist Scratch folder. Jun 29, 2012
README.rst Fix Typo In README.md Apr 24, 2019
changelog.rst 0 Aug 27, 2014
install.sh Merge branch 'master' of github.com:gu-fan/riv.vim Oct 17, 2018

README.rst

Riv: Notes and wiki in rst

Last Update:2018-01-21
Version: 0.793

New Changes

0.793: fix the RivInstruction, add RivDoc

0.792: fix the python/rst syntax file

0.791: Add a conceal syntax for *.rst filelink

0.79: As The clickable is not stable, and with many voting to disable it, revert to 0.77.

Intro

Riv is a vim plugin for taking notes with reStructuredText.

https://user-images.githubusercontent.com/579129/35188163-ea914ce8-fe6b-11e7-8a8e-11527785122b.gif

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

Comparison

First things first.

There are some other note plugins in Vim, like vimwiki, vim-notes, VOoM, etc.

Also org-mode if you are an Emacs fan.

Why use this plugin?

In comparison, the biggest advantage of Riv.vim is reStructuredText support.

reStructuredText is a markup language.

Its syntax is similar to markdown, but more powerful and extensible. Tables, LaTex, etc. are supported.

It's widely used in the Python community, and has many relevant plugins. Sphinx (www.readthedocs.org) Pygments, Nikola, etc.

Here is a post comparing reStructuredText and Markdown: https://gist.github.com/dupuy/1855764

Features

Wiki
Write wiki with project and file link support. TODO syntax is added.
Editing
Faster typing, easier navigation, clear indenting, auto formatting etc.
Reading
Improved syntax highlighting and folding support for reading document clearly.
Publish
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.
Plugins

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

Contribution to this list are welcome.

Installation

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.

Config

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

Tutorials

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.

Issues

The bug tracker for Riv is at https://github.com/Rykka/riv.vim/issues. 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 tweet 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-refold 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.

License

MIT

You can’t perform that action at this time.