djyde / koy

Markdown previewer

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 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

koy's Issues

Improve README.md for Readability

Edit README.md to be more readable (just a couple of minor edits).

TypeError: app.exposeObject is not a function

Derived from #16

README.md: add usage for locally installed koy

User might not want to pollute their global environment with npm install koy -g and choose to install locally via npm install koy. That way, users need to invoke koy this way:

node_modules/.bin/koy FILENAME.md

or alternatively,

npx koy FILENAME.md

npx is a utility of NPM. It will check the node_modules in the current directory for the executable. If not found, it will automatically download the package.

By the way, Carlo author's team members send their regards.

Feature request: Memorize window size

https://github.com/GoogleChromeLabs/carlo/blob/master/API.md#launchoptions

Carlo accepts app width and height so we can memorize window size on resizing and restore size when creating the app.

Feature Request: preview content from stdin

This is the easy way for us to get content from a remote file(#6) or clipboard, etc.

Such as

# from echo command
echo "# Hello" | koy

# from remote
curl example.com/foo.md | koy

# from clipboard
clippaste | koy

We can use get-stdin to implement the feature.

Feature request: open links in Chrome

Currently links will open in current window

[Bug]: Blank page in ubuntu 16.04

node-version: v8.11.3

After running koy README.md, the preview window show a blank page with empty body content

Feature request: preview remote files

Not sure if this is useful tho 😅

koy https://example.com/foo.md

Cannot render local images

Images in following markdown content can not display after koy rendering.

## I wanna show this image:

![](./image.png)

Feature request: Syntax highlighting

With Prism.js