Last Update: | 2018-01-21 |
---|---|
Version: | 0.793 |
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 with reStructuredText.
riv.vim (vim) + InstantRst (web server) + rhythm.css (theme)
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
Support many plugins like Sphinx syntax support. Other RST plugins:
Contribution to this list are welcome.
Recommended
Add this line to your .vimrc
(after you have properly set up Vundle):
Bundle 'Rykka/riv.vim'
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
.
You can have a quick start with :RivQuickStart
.
Here is the Screencast:
vimtutor
. To use it simply type vimtutor
in your shell.:h quickref
.To get a quick overview of reStructuredText, some of the available options are:
Read "A ReStructuredText Primer". You can use :RivPrimer
to open it in
Vim. Or, you can read "Quick reStructuredText".
For a detailed look at reStructuredText's specifications, take a look at
"reStructuredText Specification". You can use :RivSpecification
to
open it in Vim.
Finally, you can use "reStructuredText cheatsheet" for a quick review. Use
:RivCheatSheet
to open it in Vim.
:RivQuickStart
in Vim.:RivInstruction
to read the same in Vim.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.
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.
MIT
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。