robot1d59cc305 / koy

Preview markdown file

Koy

Koy is a markdown previewer powered by Carlo.

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 a README.md in NPM
$ koy npm:koy

License

MIT License