Vim plugin for previewing markup files(markdown,rdoc,textile,html)
by Sergey Potapov (aka Blake)
Preview plugin is a tool developed to help you to preview markup files such as .markdown, .rdoc, .textile and .html when you are editing them. It builds html files and opens them in your browser.
The plugin supports the next formats:
redcarpetruby gem
github-markupruby gem
RedClothruby gem
ronnruby gem
RbSTruby gem and
rst2htmlsystem util
The plugin requires a builtin ruby interpreter. It means that your Vim should be compiled with
--enable-rubyinterpoption. To find out does your Vim have builtin ruby interpreter you can do the next: :echo has('ruby')
If output is
1the ruby interpreter is builtin.
The second thing you should verify is that you have installed all necessary ruby gems. Please see "Supported Formats" section to find out what gems you need.
For reStructuredText(rst) format except
RbSTruby gem you also need
rst2html. To get
rst2htmlutil you probably should install
python-docutilspackage. Otherwise PreviewRst vim command will show empty html file.
To install the plugin just copy
autoload,
plugin,
docdirectories into your .vim directory.
I want to remind that <Leader> in most cases is "\" key.
If you encountered this err when you press <Leader>P.
Preview: don't know how to handle .modula2 format
You may add this piece of code to .vimrc
autocmd BufNewFile,BufRead \*.{md,mdwn,mkd,mkdn,mark\*} set filetype=markdown
If you found a bug, please report it. Or better send me a pull request:)
.html. There should be
vim_previewprefix, PID of Vim and number of buffer to guarantee avoiding conflicts.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA