extra.py 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. # markdown is released under the BSD license
  2. # Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later)
  3. # Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
  4. # Copyright 2004 Manfred Stienstra (the original version)
  5. #
  6. # All rights reserved.
  7. #
  8. # Redistribution and use in source and binary forms, with or without
  9. # modification, are permitted provided that the following conditions are met:
  10. #
  11. # * Redistributions of source code must retain the above copyright
  12. # notice, this list of conditions and the following disclaimer.
  13. # * Redistributions in binary form must reproduce the above copyright
  14. # notice, this list of conditions and the following disclaimer in the
  15. # documentation and/or other materials provided with the distribution.
  16. # * Neither the name of the <organization> nor the
  17. # names of its contributors may be used to endorse or promote products
  18. # derived from this software without specific prior written permission.
  19. #
  20. # THIS SOFTWARE IS PROVIDED BY THE PYTHON MARKDOWN PROJECT ''AS IS'' AND ANY
  21. # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22. # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  23. # DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTORS TO THE PYTHON MARKDOWN PROJECT
  24. # BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25. # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26. # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27. # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28. # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29. # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30. # POSSIBILITY OF SUCH DAMAGE.
  31. """
  32. Python-Markdown Extra Extension
  33. ===============================
  34. A compilation of various Python-Markdown extensions that imitates
  35. [PHP Markdown Extra](http://michelf.com/projects/php-markdown/extra/).
  36. Note that each of the individual extensions still need to be available
  37. on your PYTHONPATH. This extension simply wraps them all up as a
  38. convenience so that only one extension needs to be listed when
  39. initiating Markdown. See the documentation for each individual
  40. extension for specifics about that extension.
  41. In the event that one or more of the supported extensions are not
  42. available for import, Markdown will issue a warning and simply continue
  43. without that extension.
  44. There may be additional extensions that are distributed with
  45. Python-Markdown that are not included here in Extra. Those extensions
  46. are not part of PHP Markdown Extra, and therefore, not part of
  47. Python-Markdown Extra. If you really would like Extra to include
  48. additional extensions, we suggest creating your own clone of Extra
  49. under a differant name. You could also edit the `extensions` global
  50. variable defined below, but be aware that such changes may be lost
  51. when you upgrade to any future version of Python-Markdown.
  52. """
  53. from __future__ import absolute_import
  54. from __future__ import unicode_literals
  55. from . import Extension
  56. extensions = ['smart_strong',
  57. 'fenced_code',
  58. 'footnotes',
  59. 'attr_list',
  60. 'def_list',
  61. 'tables',
  62. 'abbr',
  63. ]
  64. class ExtraExtension(Extension):
  65. """ Add various extensions to Markdown class."""
  66. def extendMarkdown(self, md, md_globals):
  67. """ Register extension instances. """
  68. md.registerExtensions(extensions, self.config)
  69. if not md.safeMode:
  70. # Turn on processing of markdown text within raw html
  71. md.preprocessors['html_block'].markdown_in_raw = True
  72. def makeExtension(configs={}):
  73. return ExtraExtension(configs=dict(configs))