Skip to main content

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

Project description

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


Release history Release notifications

This version
History Node

2.0.2

History Node

2.0.1

History Node

2.0.0

History Node

1.0.8

History Node

1.0.7

History Node

1.0.6

History Node

1.0.5

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

History Node

0.1.9

History Node

0.1.8

History Node

0.1.7

History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

History Node

0.0.2

History Node

0.0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
ghmarkdown-2.0.2-py3-none-any.whl (11.4 kB) Copy SHA256 hash SHA256 Wheel py3 Nov 23, 2017
ghmarkdown-2.0.2.tar.gz (9.5 kB) Copy SHA256 hash SHA256 Source None Nov 23, 2017

Supported by

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