Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.17 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.17 KB

Vim - Github Markdown Preview

npm version

Vim plugin for gh-preview — Github markdown preview, as you type.

preview

Getting started

Install gh-preview:

$ npm install -g [email protected]

Once installed, vim-gh-preview should just work.

Options

Below are the overridable defaults for the options exposed by this plugin:

" Should the server start automatically when editing markdown files?
" If something is already listening at `g:ghp_port`, it is assumed to be an
" existing gh-preview server and a new server is *NOT* started.
let g:ghp_start_server = 1

" Should the browser page be opened automatically?
let g:ghp_open_browser = 1

" The port `gh-preview` (is running | will be started) at
let g:ghp_port = 1234

Installation - Plugged.vim

Plug 'felixschl/vim-gh-preview'

Installation - Vundle.vim

Plugin 'felixschl/vim-gh-preview'