

GitHub - Rykka/riv.vim: Take Notes in rst.
source link: https://github.com/Rykka/riv.vim
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

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.
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:
- Vim & Python: InstantRst for previewing RST documents instantly.
- Vim & Python: Syntastic for syntax checking. Requires Docutils and Pygments.
- Python: Sphinx for Sphinx users.
- Python: Nikola or pelican for static blogging with RST syntax.
- Python: HoverCraft for writing presentation from RST.
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:
- Riv: QuickStart (HD)
New To Vim
- If you are new to Vim, you can get a basic overview of Vim using
vimtutor
. To use it simply typevimtutor
in your shell. - To view the quick reference of Vim, use
:h quickref
.
New To RST
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.
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
Recommend
-
13
Introduction reStructuredText (one word) is a plain-text markup language for writing technical documents, books, websites, and more. It is eas...
-
11
docs/drivers/zink.rst · master · Mesadocs: document new zink-flag Erik Faye-Lun...
-
12
Sphinx帮助我通过rst生成静态html Dec 23, 2016 windows下使用sphinx生成静态网页。 官方教程,特详细 http://www.sphinx-doc.org/en/stable/tutorial.html 参考IBM https://www.ibm.com/develo...
-
9
rst_tables 改进版 本文来自依云's Blog,转载请注明。 rst_tables 是一个用...
-
9
Zig Compiler Internals note: Due to limitations of this article format we overload diff syntax highlighting to achieve a highlighting effect for code listings. Consequently, highlighted lines will display an exclamatio...
-
15
Permalink main
-
38
ansible-core 2.13 "Nobody's Fault but Mine" Release Notes v2.13.0
-
10
main ideas/main-vs-310.rst
-
23
The Linux Watchdog driver API Last reviewed: 10/05/2007 Copyright 2002 Christer Weingel <[email protected]> Some parts of this document are copied verbat...
-
5
Important notes This section provides information about security and corruption issues. Pre-1.1.11 potential index corruption / data loss issue A bug was discovered in our hashtable code, see issue #4829. The code is used...
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK