Repository files navigation

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.

Riv is a vim plugin for taking notes withreStructuredText.

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

First things first.

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

Alsoorg-mode if you are an Emacs fan.

Why use this plugin?

In comparison, the biggest advantage ofRiv.vim isreStructuredText support.

reStructuredText is a markup language.

Its syntax is similar tomarkdown, 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

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 themerhythm.css is added for better performance.

Plugins

Support many plugins likeSphinx syntax support.Other RST plugins:

• Vim & Python:InstantRst for previewing RST documents instantly.
• Vim & Python:Syntastic for syntax checking. RequiresDocutils andPygments.
• Python:Sphinx for Sphinx users.
• Python:Nikola orpelican for static blogging with RST syntax.
• Python:HoverCraft for writing presentation from RST.

Contribution to this list are welcome.

RecommendedAdd this line to your.vimrc (after you have properly set upVundle):

Bundle 'Rykka/riv.vim'

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

You can add projects withg: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 inruntimepath.By default itis present before$VIMRUNTIME.

Also make surefiletype plugin indent on andsyntax on optionsare present in your.vimrc.

You can have a quick start with:RivQuickStart.

Here is the Screencast:

• Riv:QuickStart (HD)

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

• To get a quick overview of reStructuredText, some of the available optionsare:

  Read "A ReStructuredText Primer". You can use:RivPrimer to open it inVim. Or, you can read "Quick reStructuredText".

• For a detailed look at reStructuredText's specifications, take a look at"reStructuredText Specification". You can use:RivSpecification toopen it in Vim.

• Finally, you can use "reStructuredText cheatsheet" for a quick review. Use:RivCheatSheet to open it in Vim.

• 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 athttps://github.com/Rykka/riv.vim/issues.You can use it to report bugs and open feature requests. Discussions relatedto Riv are welcome too.

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

• If you get errors with folding in documents, you can try to force reloadusing: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 withvimrun.exe.

• Mac OS:

  • Lists don't act as expected.

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

MIT