Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 896 Bytes

README.md

File metadata and controls

43 lines (28 loc) · 896 Bytes

Koy

Koy is a markdown previewer powered by Carlo.

preview

Features

  • View README.md in current working directory by default.
  • Render markdown in GitHub style.
  • Live preview and automatic re-rendering of file changes.

Install

$ npm i koy -g

Usage

$ koy

# Or a specific file
$ koy some-file.md

# Or a README.md in Github repo
$ koy gh:djyde/koy

# Or stdin
$ curl -sL https://github.com/djyde/koy/raw/master/README.md | koy

# Or a README.md in NPM
$ koy npm:koy

License

MIT License