Ⅰ. 插件描述
vim-quickrun plugin for Markdown by GitHub Markdown APIⅡ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'superbrothers/vim-quickrun-markdown-gfm'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall
对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'superbrothers/vim-quickrun-markdown-gfm'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall
使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'superbrothers/vim-quickrun-markdown-gfm'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall
使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/superbrothers/vim-quickrun-markdown-gfm
Ⅳ. 文档说明
# vim-quickrun-markdown-gfm
vim-quickrun-markdown-gfm converts a markdown buffer to html quickly by GitHub Markdown Rendering API.
Install with Vundle
Add the following lines to your .vimrc:
Bundle 'thinca/vim-quickrun'
Bundle 'mattn/webapi-vim'
Bundle 'tyru/open-browser.vim'
Bundle 'superbrothers/vim-quickrun-markdown-gfm'let g:quickrun_config = {
\ 'markdown': {
\ 'type': 'markdown/gfm',
\ 'outputter': 'browser'
\ }
\ }After execute :BundleInstall.
If you want to use this script on GitHub Enterprise:
let g:quickrun_markdown_gfm_github_api_url = 'https://<your-github-enterprise-hostname>/api/v3'If you want to use a GitHub OAuth token:
let g:quickrun_markdown_gfm_github_token = '<your-github-oauth-token>'Usage
:QuickRun markdown
For more information, see the help of vim-quickrun
:help quickrun
Requirements
- curl and libcurl
- Markdown Rendering | GitHub API
- thinca/vim-quickrun
- mattn/webapi-vim
- tyru/open-browser.vim
revolunet/sublimetext-markdown-preview
`github.css`, `highlight.css`, `highlight.js`
License
vim-quickrun-markdown-gfm is released under the MIT License.
Screenshots
