Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Link recognition for Python Markdown

Project description

# Mdx Linkify


This extension for [Python Markdown](
will convert text that look like links to HTML anchors.

There's an alternative package that serves the same purpose called
[`markdown-urlize`]( The main
difference is that [`mdx_linkify`]( is
utilizing the excellent [`bleach`]( for
searching links in text. :clap:

## Usage

### Minimal Example

from markdown import markdown

markdown("minimal", extensions=["mdx_linkify"])
# Returns '<p>minimal <a href=""></a></p>'

### Linkify Callbacks

It's possible to omit links that match your custom filter with linkify

For example, to omit links that end with `.txt` extension:

from mdx_linkify.mdx_linkify import LinkifyExtension
from markdown import Markdown

def dont_linkify_txt_extension(attrs, new=False):
if attrs["_text"].endswith(".txt"):
return None

return attrs

md = Markdown(
"linkify": {
"linkify_callbacks": [[dont_linkify_txt_extension], ""]

assert md.convert("not_link.txt"), '<p>not_link.txt</p>'

expected = md.convert("")
actual = '<p><a href=""></a></p>'
assert expected == actual

## Installation

The project is [on PyPI](!

pip install mdx_linkify

If you want the bleeding-edge version (this includes unreleased-to-PyPI code),
you can always grab the master branch directly from Git.

pip install git+git://

## Development

git clone
virtualenv mdx_linkify/
cd mdx_linkify/
source bin/activate
python install
python test

Pull requests are much welcome! :+1:

## Releasing

_(more like a cheatsheet for me actually)_

* Change version in ``,
* Commit and tag it,
* Push it (including tag),
* Run `python register && python sdist upload`;

Project details

Download files

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

Files for mdx_linkify, version 1.2
Filename, size File type Python version Upload date Hashes
Filename, size mdx_linkify-1.2.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page