Python-Markups module documentation

Introduction to Python-Markups

Python-Markups is a module that provides unified interface for using various markup languages, such as Markdown, reStructuredText, Textile and AsciiDoc. It is also possible for clients to create and register their own markup languages.

The output language Python-Markups works with is HTML. Stylesheets and JavaScript sections are supported.

The abstract interface that any markup implements is AbstractMarkup.

Contents

• API overview
  • Getting lists of available markups
    • get_all_markups()
    • get_available_markups()
  • Getting a specific markup
    • get_markup_for_file_name()
    • find_markup_class_by_name()
  • Configuration directory
• Markup interface
  • AbstractMarkup
    • AbstractMarkup.attributes
    • AbstractMarkup.available()
    • AbstractMarkup.convert()
    • AbstractMarkup.default_extension
    • AbstractMarkup.file_extensions
    • AbstractMarkup.name
  • ConvertedMarkup
    • ConvertedMarkup.get_document_body()
    • ConvertedMarkup.get_document_title()
    • ConvertedMarkup.get_javascript()
    • ConvertedMarkup.get_stylesheet()
    • ConvertedMarkup.get_whole_html()
• Built-in markups
  • Markdown markup
    • MarkdownMarkup
  • reStructuredText markup
    • ReStructuredTextMarkup
  • Textile markup
    • TextileMarkup
  • AsciiDoc markup
    • AsciiDocMarkup
• Custom Markups
  • Registering the markup module
  • Importing third-party modules
  • Implementing methods
• Python-Markups changelog
  • Version 4.0.0, 2023-01-16
  • Version 3.1.3, 2021-11-21
  • Version 3.1.2, 2021-09-06
  • Version 3.1.1, 2021-03-05
  • Version 3.1.0, 2021-01-31
  • Version 3.0.0, 2018-05-03
  • Version 2.0.1, 2017-06-24
  • Version 2.0.0, 2016-05-09
  • Version 1.0.1, 2015-12-22
  • Version 1.0, 2015-12-13
  • Version 0.6.3, 2015-06-16
  • Version 0.6.2, 2015-06-09
  • Version 0.6.1, 2015-04-19
  • Version 0.6, 2015-01-25
  • Version 0.5.2, 2014-11-05
  • Version 0.5.1, 2014-09-16
  • Version 0.5, 2014-07-25
  • Version 0.4, 2013-11-30
  • Version 0.3, 2013-07-25
  • Version 0.2.3, 2012-11-02
  • Version 0.2.2, 2012-10-02
  • Version 0.2.1, 2012-09-09
  • Version 0.2, 2012-09-04

Links

• Python-Markups source code is hosted on GitHub.

• You can get the source tarball from PyPI.

• It is also packaged in Debian.