https://github.com/aheckmann/greadme

Locally preview your markdown, Github style
https://github.com/aheckmann/greadme

Last synced: 4 months ago
JSON representation

Locally preview your markdown, Github style

• Host: GitHub
• URL: https://github.com/aheckmann/greadme
• Owner: aheckmann
• License: mit
• Created: 2012-08-30T20:14:30.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-05-02T02:02:32.000Z (10 months ago)
• Last Synced: 2024-09-30T01:01:25.520Z (4 months ago)
• Language: JavaScript
• Homepage: http://aheckmann.github.com/greadme/
• Size: 334 KB
• Stars: 76
• Watchers: 6
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - aheckmann/greadme - Locally preview your markdown, Github style (JavaScript)
• awesome-list - greadme

README

        
# greadme

Locally preview your markdown, Github style.

![](https://dl.dropboxusercontent.com/u/4034363/greadme.png)

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

The default port is `8124` and the default host is `localhost`. You can change these settings by passing the `--port`

and `--host` option. For example:

    $ greadme --host 127.0.0.0 --port 7220

## Notes

An attempt is made to use the [Github markdown rendering api](http://developer.github.com/v3/markdown/) and Githubs stylesheets. If the attempt fails we fall back to rendering locally.

## Contributors

https://github.com/aheckmann/greadme/graphs/contributors

## License

[MIT](https://github.com/aheckmann/greadme/blob/master/LICENSE)