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 is much more honed-in than pandoc, a massive tool with far more conversion capabilities (but lacking its own hosting capabilities).

Features

  • Host your markdown locally to easily view your changes!

  • 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 -s -i my_file.md
$ ghmarkdown --serve --input my_file.md
$ cat my_file.md | ghmarkdown --serve

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

Write markdown directly into stdin, and serve it:

$ ghmarkdown --serve
# Hello there, _user_!
```python
def foo(bar):
    raise ZeroDivisionError()
```
<Ctrl-d>
Hosting server on port 8000

Use ghmarkdown --help to see all available commands and parameters

Project details


Download files

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

Source Distribution

ghmarkdown-0.1.1.tar.gz (7.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page