ghmarkdown

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)

Release files for ghmarkdown 2.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ghmarkdown 2.0.2
File	Size	Uploaded
ghmarkdown-2.0.2.tar.gz	9.5 kB	Nov 23, 2017	Details

Built distribution (wheel)

Table of built distributions (wheels) for ghmarkdown 2.0.2
File	Interpreter	ABI	Platform	Reset
ghmarkdown-2.0.2-py3-none-any.whl 11.4 kB Nov 23, 2017	Python 3	none	any	Details

Total release size: 20.9 kB

Release files / ghmarkdown-2.0.2.tar.gz

Download URL	ghmarkdown-2.0.2.tar.gz
Size	9.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`d55e9f19ef27c01544fa25832308a524c014282a18529be0e5fe5c6b768c4758`
BLAKE2b-256 checksum How to use checksums	`f56b9e2a21c2b952f0998d963e57a275d564066a1e6fd38105926f02212b7e39`
Upload date	Nov 23, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / ghmarkdown-2.0.2-py3-none-any.whl

Download URL	ghmarkdown-2.0.2-py3-none-any.whl
Size	11.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a6214be8eaf1ee4ab9ca46bc668abee7d89b30137f1cbdc6e3a0cb84ce2f62a9`
BLAKE2b-256 checksum How to use checksums	`599b761390dfcff3946e7ca0ce5defdc320a4e09f59c23526beb07dbfc2f5427`
Upload date	Nov 23, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No