ghmarkdown

2.0.2 verified Sat May 09 auth: no python

A command-line tool for rendering GitHub-flavored Markdown (GFM). Version 2.0.2 supports GFM tables, task lists, strikethrough, emoji, and user mentions. Release cadence is low (last update years ago).

pip install ghmarkdown

Common errors

error ModuleNotFoundError: No module named 'ghmarkdown' ↓

cause The package is not installed, or installed in a different environment.

fix

Run pip install ghmarkdown.

error ImportError: cannot import name 'github_flavored_markdown' from 'ghmarkdown' ↓

cause Older version (<2.0) may not have this function.

fix

Ensure ghmarkdown >=2.0: pip install --upgrade ghmarkdown.

Warnings

gotcha The CLI tool is named `ghmarkdown`, not `gh-markdown`. ↓

fix Use `ghmarkdown` as the command, not `gh-markdown`.

deprecated The library has not been updated since 2019 and may not support newer GFM features (e.g., alerts, footnotes). ↓

fix Consider alternatives like `markdown` with `pymdown-extensions` or `mistune` for active development.

Imports

ghmarkdown
```
import ghmarkdown
```
The package exposes a module-level function; no submodule needed.

Quickstart

Convert a GFM string to HTML using the Python API.

import ghmarkdown

result = ghmarkdown.github_flavored_markdown('# Hello')
print(result)  # <h1>Hello</h1>