enkidevs / nk-md

:art: Preview enki insight files in a separate window.
MIT License
4 stars 1 forks source link

nk-md

NPM version build status js-standard-style

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

Features | Installation | Usage | Examples | Command-line options

screenshot

Features

Installation

$ npm install -g nk-md

Or download an executable from the release page

Usage

nk-md [FILE] [OPTIONS]

If no FILE is provided it will try to read from standard input.

Examples

Read a file from disk:

$ nk-md DOCUMENT.md

It reads from stdin so you can pipe markdown text in to it:

$ cat README.md | nk-md

Options

Note

nk-md JavaScript/Classes/object-prototype.md

Authors

License

MIT