mdview

A markdown viewer that allows one to test his or her readme prior to pushing to GitHub, GitLab, or publishing to the npm registry.

mdview

A very simple markdown viewer that allows one to test his or her readme prior to pushing to GitHub, GitLab, or publishing to the npm registry.

$ npm install -g mdview

Requires grunt

$ npm install -g grunt-cli
$ grunt test
  Usage: mdview [options]
 
  Options:
 
    -h, --help           output usage information
    -V, --version        output the version number
    -v, --verbose        Increase verbosity
    -p, --port <port>    Port on which to run the server (3000)
    -c, --css <style>    Customize css
    -o, --open           Open in default browser
 

Currently, the following styles are available by default

  • default
  • npm
  • github
  • gitlab

One can pass in the path to another css file that will be used

MIT