ghmarkdown 0.1.6

ghmarkdown is the complete command-line tool for GitHub-flavored markdown

The complete command-line tool for GitHub-flavored markdown. It provides a convenient interface for the API provided by GitHub.

ghmarkdown’s –serve feature let’s you locally view your markdown live, so you can view your changes as you work!

Features

• Host your markdown locally to easily view your changes as you make them!

• Easy to install

• Easy to use

• Works on Mac, Linux and Windows

Installation

$ pip install ghmarkdown

Usage

Run your markdown on a local server:

# these do the same thing
$ ghmarkdown -si my_file.md
$ ghmarkdown --serve --input my_file.md
$ cat my_file.md | ghmarkdown --serve # doesn't update changes

Parse your markdown to HTML locally:

# these do the same thing
$ ghmarkdown -i my_file.md -o my_page.html
$ ghmarkdown --input my_file.md --output my_page.html
$ cat my_file.md | ghmarkdown > my_page.html

Use ghmarkdown --help to see all available commands and parameters

GitHub limits usage of its api, so if you want more than 60 req/hr use --login (you’ll get 5000 req/hr!)