Source code for mdx_gfm
# Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file
# for details. All rights reserved. Use of this source code is governed by a
# BSD-style license that can be found in the LICENSE file.
"""
:mod:`mdx_gfm` -- Full extension for GFM (comments, issues)
===========================================================
An extension that is as compatible as possible with GitHub-flavored
Markdown (GFM).
This extension aims to be compatible with the standard GFM that GitHub uses
for comments and issues. It has all the extensions described in the `GFM
documentation`_, except for intra-GitHub links to commits, repositories,
and issues.
Note that Markdown-formatted gists and files (including READMEs) on GitHub
use a slightly different variant of GFM. For that, use
:class:`mdx_partial_gfm.PartialGithubFlavoredMarkdownExtension`.
.. _GFM documentation: https://guides.github.com/features/mastering-markdown/
"""
# Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file
# for details. All rights reserved. Use of this source code is governed by a
# BSD-style license that can be found in the LICENSE file.
from markdown.extensions.nl2br import Nl2BrExtension
from mdx_partial_gfm import PartialGithubFlavoredMarkdownExtension
def makeExtension(**kwargs):
return GithubFlavoredMarkdownExtension(**kwargs)
[docs]class GithubFlavoredMarkdownExtension(PartialGithubFlavoredMarkdownExtension):
"""
An extension that is as compatible as possible with GitHub-flavored
Markdown (GFM).
This extension aims to be compatible with the standard GFM that GitHub uses
for comments and issues. It has all the extensions described in the `GFM
documentation`_, except for intra-GitHub links to commits, repositories,
and issues.
Note that Markdown-formatted gists and files (including READMEs) on GitHub
use a slightly different variant of GFM. For that, use
:class:`mdx_partial_gfm.PartialGithubFlavoredMarkdownExtension`.
.. _GFM documentation: https://guides.github.com/features/mastering-markdown/
"""
[docs] def extendMarkdown(self, md):
PartialGithubFlavoredMarkdownExtension.extendMarkdown(self, md)
Nl2BrExtension().extendMarkdown(md)