Ⅰ. 插件描述
preview markdown documents in the browser from vimⅡ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'nelstrom/vim-markdown-preview-the-story-of-us'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall
对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'nelstrom/vim-markdown-preview-the-story-of-us'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall
使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'nelstrom/vim-markdown-preview-the-story-of-us'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall
使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/nelstrom/vim-markdown-preview
Ⅳ. 文档说明
## vim-markdown-preview
vim-markdown-preview adds the option to preview markdown documents in the
browser from the vim editor.
The web page it opens is loosely styled on how GitHub would render README.mkd.
Install
Download
- Option 1
Cloning this repository is one option, and the master branch should always be
in a working state.
- Option 2
You can download versioned releases from the
downloads page.
Automatic installation
vim-markdown-preview is bundled with an installer script which will install to
$HOME/.vim/plugin/
sh install.sh
Usage
Send vim the command :Mm for a preview of your markdown document.
Alternatively, bind :Mm to a key binding: map <leader>p :Mm<CR>
Dependencies
- vim
- Ruby support for vim.
- kramdown (bundled with this package)
OSX
vim-markdown-preview was written to run on OSX, and it will work w/o
- I recommend the safari browser because it will not open new tabs needlessly
if a document is already loaded in an existing tab/window.
Linux/Others
vim-markdown-preview is tied to the OSX command open.
You will need to replace it with something else - firefox-bin, for example,
for it to work on your operating system.
Credit
- Mathias Billman
This is an enitrely rewritten version of the vim script originally written by
Mathias Billman and found
here.
Bugs
No known bugs right now.
Found a bug?.
Contact
- IRC
irc.freenode.net/#flowof.info as 'robgleeson' - Mail
rob [at] flowof.info