Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 2.23 KB

README.rst

File metadata and controls

79 lines (56 loc) · 2.23 KB
Raw

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)