Skip to main content

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

Project description

PyPi version

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!

usage gif


  • Host your markdown locally to easily view your changes upon refresh.
  • Easy to install
  • Easy to use
  • Works on Mac, Linux, and Windows


pip install ghmarkdown


Run your markdown on a local server:

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

Parse your markdown to HTML locally:

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

See all features and parameters:

$ ghmarkdown --help
  ghmarkdown [--help | --version] [--login] [--bare] [--verbose] [--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
  --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)
  --verbose, -v         displays 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)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghmarkdown-2.0.2.tar.gz (9.5 kB view hashes)

Uploaded source

Built Distribution

ghmarkdown-2.0.2-py3-none-any.whl (11.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page