Skip to content

Preview markdown file with marked.

License

Notifications You must be signed in to change notification settings

hyrious/marked-cli

Repository files navigation

@hyrious/marked-cli

A simple script to preview local markdown file with hot reload.

Want to use it in VS Code? Check out this extension!

Usage

npx @hyrious/marked-cli README.md
serving http://localhost:5000

Options

There's none.

The first version of this script is quickly written in 10 minutes. You can submit a PR or raise an issue if you really need some configuration.

What's in it?

This package has 2 purposes:

  • Let the rendering result be like GitHub.com as much as possible.
  • As small as possible.

Common Issues

If you're using macOS and found localhost:5000 cannot be reached, it is highly possible that AirPlay Receiver is taking over the port. You can turn off AirPlay Receiver from System Settings → General → AirDrop & handoff → AirPlay Receiver.

License

MIT @ hyrious

About

Preview markdown file with marked.

Resources

License

Stars

Watchers

Forks

Packages

No packages published