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
See all features and parameters:
$ ghmarkdown --help usage: ghmarkdown [--help | --version] [--login] [--bare] [--silent] [--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) --silent, -q silences 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 | 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.6.tar.gz
(8.3 kB
view hashes)
Built Distribution
Close
Hashes for ghmarkdown-1.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5987c2ee7ecdcc3042489789c41fa09b80a3b51e43d21da343c26d21838b6a62 |
|
MD5 | ad066a95e16b2067e2d0b0765bebff81 |
|
BLAKE2b-256 | 49aac3644b37c98ed0acf6988d59001c109b7456e601782982e3ff3153a8b3b0 |