https://github.com/felixschl/vim-gh-preview

Vim plugin for gh-preview
https://github.com/felixschl/vim-gh-preview

Last synced: 7 days ago
JSON representation

Vim plugin for gh-preview

• Host: GitHub
• URL: https://github.com/felixschl/vim-gh-preview
• Owner: felixSchl
• Created: 2015-09-02T22:23:23.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-05-31T21:13:54.000Z (over 6 years ago)
• Last Synced: 2024-11-14T04:29:49.690Z (about 2 months ago)
• Language: Python
• Size: 214 KB
• Stars: 1
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vim - Github Markdown Preview

[![npm version](https://badge.fury.io/js/gh-preview.svg)](http://badge.fury.io/js/gh-preview)

> Vim plugin for [gh-preview](https://github.com/felixSchl/gh-preview) —

> Github markdown preview, as you type.

![preview](https://raw.githubusercontent.com/felixSchl/felixSchl.github.io/master/gh-preview/preview.gif)

## Getting started

Install [gh-preview](https://github.com/felixSchl/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:

```vim

" 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

```vim

Plug 'felixSchl/vim-gh-preview'

```

#### Installation - Vundle.vim

```vim

Plugin 'felixSchl/vim-gh-preview'

```