koy

![](https://badgen.net/npm/v/koy) ![](https://badgen.net/packagephobia/install/koy) ![](https://badgen.net/badge//chrome?icon=chrome)

Usage no npm install needed!

<script type="module">
  import koy from 'https://cdn.skypack.dev/koy';
</script>

README

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

License

MIT License