greadme

Locally preview your markdown, Github style

npm install greadme
1 downloads in the last day
23 downloads in the last week
45 downloads in the last month

greadme

===========

Locally preview your markdown, Github style.

Installation

via npm:

$ npm install -g greadme

Usage

$ greadme [path/to/some.markdown]

   view your markdown at http://localhost:8124/
   press CTRL+C to quit

Execute greadme passing an optional path to a markdown file and it will be parsed and served from a locally running http server with Github styling applied. When no file path is specified, greadme displays a file browser of the current directory, similar to Github.

A browser will automatically be opened to preview the markdown if your OS supports it.

Files with the following extensions are rendered.

  • .md
  • .markdown

Notes

An attempt is made to use the Github markdown rendering api and Githubs stylesheets. If the attempt fails we fall back to rendering locally.

Contributors

License

MIT

npm loves you