gfm – Base module for GitHub-Flavored Markdown

class gfm.AutolinkExtension(**kwargs)[source]

An extension that turns URLs into links.

extendMarkdown(md)[source]

Add the various proccesors and patterns to the Markdown Instance.

This method must be overriden by every extension.

Keyword arguments:

  • md: The Markdown instance.
  • md_globals: Global variables in the markdown module namespace.
class gfm.AutomailExtension(**kwargs)[source]

An extension that turns email addresses into links.

extendMarkdown(md)[source]

Add the various proccesors and patterns to the Markdown Instance.

This method must be overriden by every extension.

Keyword arguments:

  • md: The Markdown instance.
  • md_globals: Global variables in the markdown module namespace.
class gfm.SemiSaneListExtension(**kwargs)[source]

An extension that causes lists to be treated the same way GitHub does.

extendMarkdown(md)[source]

Add the various proccesors and patterns to the Markdown Instance.

This method must be overriden by every extension.

Keyword arguments:

  • md: The Markdown instance.
  • md_globals: Global variables in the markdown module namespace.
class gfm.StandaloneFencedCodeExtension(**kwargs)[source]
extendMarkdown(md)[source]

Add FencedBlockPreprocessor to the Markdown instance.

class gfm.StrikethroughExtension(**kwargs)[source]

An extension that adds support for strike-through text between two ~~.

extendMarkdown(md)[source]

Add the various proccesors and patterns to the Markdown Instance.

This method must be overriden by every extension.

Keyword arguments:

  • md: The Markdown instance.
  • md_globals: Global variables in the markdown module namespace.
class gfm.TaskListExtension(**kwargs)[source]

An extension that supports GitHub task lists. Both ordered and unordered lists are supported and can be separately enabled. Nested lists are supported.

Example:

- [x] milk
- [ ] eggs
- [x] chocolate
- [ ] if possible:
    1. [ ] solve world peace
    2. [ ] solve world hunger
extendMarkdown(md)[source]

Add the various proccesors and patterns to the Markdown Instance.

This method must be overriden by every extension.

Keyword arguments:

  • md: The Markdown instance.
  • md_globals: Global variables in the markdown module namespace.