Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

Features

  • Host your markdown locally to easily view your changes upon refresh.
  • 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

See all features and parameters:

$ ghmarkdown --help
usage:
  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
  --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)
  --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.

Files for ghmarkdown, version 2.0.2
Filename, size File type Python version Upload date Hashes
Filename, size ghmarkdown-2.0.2-py3-none-any.whl (11.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size ghmarkdown-2.0.2.tar.gz (9.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page