py-gfm documentation¶
This is an implementation of GitHub-Flavored Markdown written as an extension to the Python Markdown library. It aims for maximal compatibility with GitHub’s rendering.
py-gfm code is under a BSD-style license.
Installation¶
pip install py-gfm
Quick start¶
All-in-one extension¶
import markdown
from mdx_gfm import GithubFlavoredMarkdownExtension
source = """
Hello, *world*! This is a ~~good~~marvelous day!
Here is an auto link: https://example.org/
Le me introduce you to [task lists] (https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments):
- [ ] eggs
- [x] milk
You can also have fenced code blocks:
```
import this
```
"""
# Direct conversion
html = markdown.markdown(source,
extensions=[GithubFlavoredMarkdownExtension()])
# Factory-like
md = markdown.Markdown(extensions=[GithubFlavoredMarkdownExtension()])
html = md.convert(source)
À la carte¶
import markdown
from gfm import AutolinkExtension, TaskListExtension
html = markdown.markdown(source,
extensions=[AutolinkExtension(),
TaskListExtension(max_depth=2)])
Available extensions¶
gfm.autolink– Turn URLs into linksgfm.automail– Turn email addresses into linksgfm.hidden_hilite– Fenced code blocks with no highlightinggfm.semi_sane_lists– GitHub-like list parsinggfm.spaced_link– Links with optional whitespacegfm.strikethrough– Strike-through supportgfm.tasklist– Task list support
Modules¶
Supported features¶
- Fenced code blocks
- Literal line breaks
- Tables
- Hyperlink parsing (
http,https,ftp,emailandwwwsubdomains) - Code highlighting (dummy, no actual syntactic coloration as-is)
- Mixed-style lists with no separation
- Links and images with whitespace
- Strikethrough
- Task lists
Unsupported features¶
This implementation does not support all of GFM features.
By design¶
- Link to commits, issues, pull requests and user profiles: this is application specific. Feel free to subclass the provided classes to implement your own logic.
Planned¶
- Horizontal rules
- Emojis