gfm.autolink – Turn URLs into links

The gfm.autolink module provides an extension that turns all raw URLs into marked-up links.

This is based on the web-only URL regex by John Gruber (public domain).

This regex seems to line up pretty closely with GitHub’s URL matching. Two cases were identified where they differ. In both cases, the regex were slightly modified to bring it in line with GitHub’s parsing:

• GitHub accepts FTP-protocol URLs;
• GitHub only accepts URLs with protocols or www., whereas Gruber’s regex accepts things like foo.com/bar.

Typical usage

import markdown
from gfm import AutolinkExtension

print(markdown.markdown("I love this http://example.org/ check it out",
                        extensions=[AutolinkExtension()]))

<p>I love this <a href="http://example.org/">http://example.org/</a> check it out</p>

class gfm.autolink.AutolinkExtension(*args, **kwargs)

Bases: markdown.extensions.Extension

An extension that turns URLs into links.

getConfig(key, default='')

Return a setting for the given key or an empty string.

getConfigInfo()

Return all config descriptions as a list of tuples.

getConfigs()

Return all configs settings as a dict.

setConfig(key, value)

Set a config setting for key with the given value.

setConfigs(items)

Set multiple config settings given a dict or list of tuples.