Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vmd) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vmd

Preview markdown files in a separate window. Markdown is formatted exactly the same as on GitHub.

screenshot

Installation

$ npm install -g vmd

Usage

$ vmd DOCUMENT.md

When no path to a document is supplied, "README.md" will be opened by default.

$ vmd

You can also pipe markdown content into stdin:

$ cat README.md | vmd

For example, you can see the markdown for browserify like so:

$ npm view browserify readme | vmd

Configuration

If you wish to change some of the default settings create a config file called .vmdrc in your home directory or in ~/.config/vmd.

Here's a sample config file (shows the default values):

zoom = 1.0
document = README.md

zoom is the zoom factor. If you prefer the text in vmd to be bigger you can change this to a higher value, like 1.25.
document is the default document name. This is the file that vmd will try to open if you start vmd without providing a path to a document, i.e. if you just type vmd.

If you have configured a nice zoom factor but changed your mind just for this particular time you can override the settings using command-line arguments. Like this: vmd --zoom=2 MYFILE.md

Authors

License

MIT