44 lines
1.4 KiB
Plaintext
Executable File
44 lines
1.4 KiB
Plaintext
Executable File
*vmp.txt* Plugin for previewing markdown documents in the browser.
|
|
|
|
vim-markdown-preview is a customizable plugin for previewing markdown
|
|
documents in the browser.
|
|
|
|
Through custom stylesheets, you can customize the HTML preview of a
|
|
document, but defaults stylesheets are provided.
|
|
|
|
I'm a big GitHub user, so there is a stylesheet that styles a markdown
|
|
document like it would appear on the GitHub website.
|
|
|
|
If you write your own stylesheet, please share it!
|
|
See http://github.com/robgleeson/vim-markdown-preview.
|
|
|
|
== Commands
|
|
:Mm
|
|
Launches the browser of your choice with a preview of your document.
|
|
|
|
== Options
|
|
All of these options can be customized using the following syntax in your .vimrc :
|
|
let g:VMPoutputdirectory = '/home/name/documents'
|
|
|
|
g:VMPoutputformat
|
|
The format to preview your document in.
|
|
Defaults to "html". The only supported option at this time.
|
|
|
|
g:VMPoutputdirectory
|
|
The directory where your preview should be stored.
|
|
Defaults to "/tmp".
|
|
|
|
g:VMPhtmlreader
|
|
The application or browser to open your preview.
|
|
Defaults to "open" on OSX.
|
|
Defaults to "start" on MS Windows.
|
|
Defaults to "xdg-open" on Unix.
|
|
|
|
g:VMPstylesheet
|
|
The stylesheet to style your preview with.
|
|
Stylesheets are searched for in the vim-markdown-preview/stylesheets/ directory.
|
|
|
|
Defaults to "github.css".
|
|
Other options are "safari-reader.css", "simple-print.css".
|
|
|