Riv: reStructuredText in Vim
Riv, short for 'reStructuredText in Vim'.
Aim to provide better support of reStructuredText (a simple and powerful plain text markup) in vim.
It's for you to:
Read documents clearer. (Folding, Linking and Extra highlight) Write documents faster. (Indent and Insert improvement) Manage documents easier. (Project,File and Sphinx support) Make things documented. (Todo and Scratch)
Reading and Writing
Folding: Overview the structure. Syntax: Extra highlighting. Indent: Smarter indent. Insert: Speed up the input!
Sections: Easy create, easy view. Lists: Auto numbered, auto leveled and auto indented. Links: Jumping and Highlighting. Table: Auto formatted. Publish: Convert to html/xml/latex/odt...
Sphinx: Working with Sphinx. Project: A workspace for your documents. File: Link local file in the document. Scratch: Writing notes and diaries. Helpers: Help work with document/project. Todos: Keep track of todo things.
ScreenShot: Work with Sphinx
- Riv: QuickStart (HD)
Where To Go
- Index : Index of Document
- Install: Installation
- Tutors : From the very basic
- Instructions : The detailed instruction. Use :RivInstruction in vim.
About This Projcet
Using Vundle (Recommended)
Add this line to your vimrc:
Using downloaded zip/tar.gz file. Just extract it to your .vim folder .
Make sure your .vim folder in option runtimepath is before the $VIMRUNTIME, otherwise the syntax/indent files for rst files will use vim's built-in one.
Default is before $VIMRUNTIME.
Make sure filetype plugin indent on and syntax on is in your vimrc
It's a developing version. So things may change quickly.
You can get the latest version at https://github.com/Rykka/riv.vim
python: docutils , required for converting to other format.
python: pygments for syntax highlighting in other format.
python: Sphinx for Sphinx users.
But if you are using Sphinx's tools set, you'd better not using it. Cause it could not recognize the sphinx's markups.
- To get a tutor for vim. Use vimtutor in your shell.
- To view the quick reference of vim. Use :h quickref.
To get a quick view of reStructuredText.
Read A ReStructuredText Primer, Use :RivPrimer to open it in vim.
or Read Quick reStructuredText.
To get reStructuredText's detailed specification.
Read reStructuredText Specification, Use :RivSpecification to open it in vim.
And the reStructuredText cheatsheet for a quick review, Use :RivCheatSheet to open it in vim.
Todo and Done
Things todo in this version.
- #21: Fix section syntax to ignore '::' and '..'.
- #25: Fix tutor's document path.
- #27: Add g:riv_default_path ('~/Documents/Riv')
See riv_todo (doc/riv_todo.rst)
See riv_log (doc/riv_log.rst)
If the document folding showing some error. You can try force reload :RivTestReload <C-E>t`
Converting to other format may fail.
This may due to docutils could not executing correctly with vimrun.exe.
The List don't act as expected.
Maybe Caused the <C-Enter> Could not be mapped. Use other map instead.
Post issues at https://github.com/Rykka/riv.vim/issues Both bug reports and feature request and discussions are welcome.
This project aims to provide better working with reStructuredText in vim.
And there are many things need to do.
If you are willing to improve this project, You can do something for it.