ghmarkdown 1.0.3

ghmarkdown
==========

.. image:: https://pypip.in/v/ghmarkdown/badge.svg
:alt: PyPi version

.. image:: https://pypi.in/license/ghmarkdown/badge.svg
:alt: License

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!

.. figure:: http://i.imgur.com/WUCWpOM.gif
:alt: example usage gif

Features
--------

- Host your markdown locally to easily view your changes *as you make them*!
- Easy to `install <https://github.com/lukedmor/ghmarkdown#installation>`__
- Easy to `use <https://github.com/lukedmor/ghmarkdown#usage>`__
- Works on Mac, Linux and Windows

Installation
------------

.. code:: bash

$ pip install ghmarkdown


Usage
-----

Run your markdown on a local server:

.. code:: bash

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

.. code:: bash

# 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


See all features and parameters:

.. code:: bash
$ ghmarkdown --help
usage:
ghmarkdown [--help | --version] [--login] [--bare] [--silent] [--input MD]
[--output HTML | --serve [--port PORT]]

The complete command-line tool for GitHub-flavored markdown

optional arguments:
-h, --help show this help message and exit
--version
--input MD, -i MD input markdown file (otherwise STDIN)
--output HTML, -o HTML
output html file (otherwise STDOUT)
--login, -l allows for more requests
--bare, -b disable standalone html (gives fragment)
--silent, -q silences server output and rate information
--serve, -s locally serve parsed markdown
--port PORT, -p PORT

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