Repository files navigation

So, You'll see.

—InstantRst

A vim plugin for preview rst document instantly.

You can share the address through LAN too.(And, You should note, all the navigation/edit inside your rst wiki will be show on that address,if withInstantRst!)

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

This is an intro for vim usage.

To use only the server, seeinstant-rst.py.

1. Vim with Vundle or NeoBundle:

   NeoBundle 'Rykka/InstantRst'

2. Python:

# Got some issue on pypi# sudo pip install instant-rstsudo pip install https://github.com/Rykka/instant-rst.py/archive/master.zip

3. Curl:

sudo apt-get install curl

Inside a rst buffer.

:InstantRst[!]

Preview current buffer.Add! to previewALL rst buffer.

:StopInstantRst[!]

Stop Preview current bufferAdd! to stop previewALL rst buffer.

g:instant_rst_slow

Preview rst in fast or slow mode, default is0.If your computer is a bit slow, set it to 1.

g:instant_rst_browser

Web browser for preview. default is''.And thenfirefox will be used.

g:instant_rst_template

Directory where the template for rendered pages is located.

Defaults to usingrhythm.css, that is bundled with the server.

g:instant_rst_static

Directory for static files used by the template.To be used together with g:instant_rst_template

Also defaults to the bundledrhythm.css

g:instant_rst_port

The port of webserver, default is5676.

Then the server is athttp://localhost:5676

And you can open it at your lan ip too.

If your vim is installed with '+py', then it will open at your lan ip.

likehttp://192.168.1.123:5676

g:instant_rst_localhost_only

Only use localhost, and disable lan ip

Whenever your vim has '+py'

g:instant_rst_forever

Always preview all rst buffer, default is0.

g:instant_rst_bind_scroll

Bind scroll with browser.

When scrolling with Vim, The browser will scroll either.

default is1

g:instant_rst_additional_dirs

Serve additional directories for previewing, default is an empty array[].

For example:['/home/<my_user>/<my_rst_project>/images', '/home/<my_user>/<my_rst_project>/docs']

It requires the absolute path of the directory, and the last directory name is used in the server.

A request made to/images/cats/1.png will try to serve the file from/home/<my_user>/<my_rst_project>/images/cats/1.png

1. rst's inline image file contained are not displayed.

This plugin is forRiv.vim.

which is a vim plugin for writing rst documents.

for debian user, you may need to install gevent manually

sudo apt-get install libevent-devsudo apt-get install python-all-devsudo pip install greenletsudo pip install gevent

0.9.8

add support for static file directory

MIT