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!
Features
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
Use ghmarkdown --help to see all available commands and parameters
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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ghmarkdown-1.0.2.tar.gz
(8.3 kB
view hashes)
Built Distribution
ghmarkdown-1.0.2-py2-none-any.whl
(10.3 kB
view hashes)
Close
Hashes for ghmarkdown-1.0.2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9f37682e0069cd0302deb989c840799e64203be2872ed3198a4e93b69120d0c |
|
MD5 | bed2d71c7df5a2585e61e891198b404c |
|
BLAKE2b-256 | 9838c3a23c4afa38aa14467b11e7fcb6d5d9c1a2772df26092aaeb1d01c66c34 |