Note

1. Python Markdown Module Example
2. Python In Markdown
3. Python Markdown File
4. Python Markdown Module Definition
5. Python Markdown To Html

1. WebElements allows creating html documents using python objects that represent their DOM equivalents, inspired by QT. Genshi The genshi.builder module provides simple markup generation. HTMLgen A old-school module first written for Python 1.x. Debian's package maintainers' patches bring it into the twenty-first century with Python 2.7.
2. Plain - python markdown to text. Python:How to convert markdown formatted text to text. This module will help do what you describe.

The documentation for this module is an excerpt of the documentation available on the markdown2 project page on GitHub. Minor edits have been made to make the documentation fit on one page and to remove passages that are not relevant on iOS. Also, only a summary of available extras is included here, for more information on individual extras, please refer to the project page wiki.

Introduction Python-Markdown is a package that converts content in Markdown format to HTML. In this example, we will look at how to convert Markdown to HTML and automatically generate a table-of-contents. We will also look at using the command-line tool to convert content. The following are 26 code examples for showing how to use IPython.display.Markdown.These examples are extracted from open source projects. You can vote up the ones you like or vote down the ones you don't like, and go to the original project or source file by following the links above each example.

Markdown is a light text markup format and a processor to convert that to HTML. The originator describes it as follows:

“Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).”

– http://daringfireball.net/projects/markdown/

This (markdown2) is a fast and complete Python implementation of Markdown. It was written to closely match the behaviour of the original Perl-implemented Markdown.pl. markdown2 also comes with a number of extensions (called “extras”) for things like syntax coloring, tables, header-ids. See the “Extras” section below.

Quick usage:

Extras¶

By default markdown2‘s processing attempts to produce output exactly as defined by http://daringfireball.net/projects/markdown/syntax – the “Markdown core.” However, a few optional extras are also provided.

Implemented Extras¶

• code-friendly: Disable _ and __ for em and strong.
• code-color: (DEPRECATED Use fenced-code-blocks extra instead.) Pygments-based syntax coloring of <code> sections.
• cuddled-lists: Allow lists to be cuddled to the preceding paragraph.
• fenced-code-blocks: Allows a code block to not have to be indented by fencing it with ‘```‘ on a line before and after. Based on http://github.github.com/github-flavored-markdown/ with support for syntax highlighting.
• footnotes: support footnotes as in use on daringfireball.net and implemented in other Markdown processors (tho not in Markdown.pl v1.0.1).
• header-ids: Adds “id” attributes to headers. The id value is a slug of the header text.
• html-classes: Takes a dict mapping html tag names (lowercase) to a string to use for a “class” tag attribute. Currently only supports “pre” and “code” tags. Add an issue if you require this for other tags.
• link-patterns: Auto-link given regex patterns in text (e.g. bug number references, revision number references).
• markdown-in-html: Allow the use of markdown=”1” in a block HTML tag to have markdown processing be done on its contents. Similar to http://michelf.com/projects/php-markdown/extra/#markdown-attr but with some limitations.
• metadata: Extract metadata from a leading ‘—’-fenced block.
• nofollow: Add rel=”nofollow” to add <a> tags with an href. See http://en.wikipedia.org/wiki/Nofollow.
• pyshell: Treats unindented Python interactive shell sessions as <code> blocks.
• smarty-pants: Fancy quote, em-dash and ellipsis handling similar to http://daringfireball.net/projects/smartypants/. See old issue 42 for discussion.
• toc: The returned HTML string gets a new “toc_html” attribute which is a Table of Contents for the document. (experimental)
• wiki-tables: Google Code Wiki table syntax support.
• xml: Passes one-liner processing instructions and namespaced XML tags.

Python Markdown Module Example

How to turn on extras¶

Extras are all off by default and turned on as follows:

(New in v1.0.1.2) You can also now specify extras via the “markdown-extras” emacs-style local variable in the markdown text:

Functions¶

Convert the markdown-formatted text to html with the given options.

Same as markdown(), but use the text in a given file as input.

This is a Python implementation of John Gruber’sMarkdown.It is almost completely compliant with the reference implementation,though there are a few very minor differences. See John’sSyntax Documentationfor the syntax rules.

To get started, see the installation instructions, the libraryreference, and the command line interface.

Goals¶

The Python-Markdown project is developed with the following goals in mind:

• Maintain a Python library (with an optional CLI wrapper) suited to use in web server environments (never raise an exception, never write to stdout, etc.) as an implementation of the markdown parser that follows the syntax rules and the behavior of the original (markdown.pl) implementation as reasonably as possible (see differences for a few exceptions).

• Provide an Extension API which makes it possible to change and/or extend the behavior of the parser.

Features¶

Python In Markdown

In addition to the basic markdown syntax, Python-Markdown supports the followingfeatures:

• International Input

  Python-Markdown will accept input in any languagesupported by Unicode including bi-directional text. In fact the test suiteincludes documents written in Russian and Arabic.

• Extensions

  Various extensions are provided (includingextra) to change and/or extend the base syntax.Additionally, a public Extension API is availableto write your own extensions.

• Output Formats

  Python-Markdown can output documents with either HTML or XHTML style tags.See the Library Reference for details.

• Command Line Interface

  In addition to being a Python Library, acommand line script is available for your convenience.

Differences¶

While Python-Markdown strives to fully implement markdown as described in thesyntax rules, the rulescan be interpreted in different ways and different implementationsoccasionally vary in their behavior (see theBabelmark FAQfor some examples). Known and intentional differences found in Python-Markdownare summarized below:

Python Markdown File

• Middle-Word Emphasis

  Python-Markdown defaults to ignoring middle-word emphasis (and strongemphasis). In other words, some_long_filename.txt will not becomesome<em>long</em>filename.txt. This can be switched off if desired. Seethe Legacy EM Extension for details.

• Indentation/Tab Length

  The syntax rulesclearly state that when a list item consists of multiple paragraphs, “eachsubsequent paragraph in a list item must be indented by either 4 spacesor one tab” (emphasis added). However, many implementations do not enforcethis rule and allow less than 4 spaces of indentation. The implementers ofPython-Markdown consider it a bug to not enforce this rule.

  This applies to any block level elements nested in a list, includingparagraphs, sub-lists, blockquotes, code blocks, etc. They must alwaysbe indented by at least four spaces (or one tab) for each level of nesting.

  In the event that one would prefer different behavior,tab_length can be set to whatever length isdesired. Be warned however, as this will affect indentation for all aspectsof the syntax (including root level code blocks). Alternatively, a third party extension may offer a solution that meets your needs.

• Consecutive Lists

  While the syntax rules are not clear on this, many implementations (includingthe original) do not end one list and start a second list when the list marker(asterisks, pluses, hyphens, and numbers) changes. For consistency,Python-Markdown maintains the same behavior with no plans to change in theforeseeable future. That said, the Sane List Extensionis available to provide a less surprising behavior.

Python Markdown Module Definition

Support¶

Python Markdown To Html

You may report bugs, ask for help, and discuss various other issues on the bug tracker.