Ⅰ. 插件描述
Preview markdown files in the browser from vimⅡ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'mkitt/markdown-preview-vim-treacherous':source %
:PluginInstall对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'mkitt/markdown-preview-vim-treacherous':source %
:NeoBundleInstall使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'mkitt/markdown-preview-vim-treacherous':source %
:PlugInstall使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/mkitt/markdown-preview.vimⅣ. 文档说明
# markdown-preview.vim
Markdown Preview allows you to compile and preview markdown as generated HTML files. It has the ability to select and use customized stylesheets for previewing your own awesomeness. Previewing occurs within the default browser.
For more information on the plugin: :help markdown-preview within Vim or take a look at the help files on github.
Install
Download, fork, clone, or use it as a submodule within your ~/.vim/ directory.
Dependencies
Markdown Preview requires the following:
- Vim version 7.0 or above with Ruby support
Either:
- Redcarpet - The default parser to use if it's installed
- Discount - The backup parser to use if redcarpet is not found
To get the Redcarpet parser:
gem install redcarpetThe easiest way to get Discount if your rocking homebrew is:
brew install discountIf not, see the installation instructions from David Parson's Discount repository
While not a requirement, default directories are tailored to work within a bundle directory as specified by the pathogen plugin.
Currently tested to work with MacVim and Vim from Terminal.
Credits
Inspired by:
Contributing
Contributions are welcome, simply fork do your magic and send me a pull request.
MIT License
Copyright (c) 2012 by Matthew Kitt
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the 'Software'), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE