Mark

Overview

New in 12.0

Mark was rewritten from the ground up. Some subtle difference may be observed compared to older versions, but these changes were made to align better with expected nesting conventions in the majority of parsers and to improve performance.

Mark adds the ability to insert <mark></mark> tags. The syntax requires the text to be surrounded by double equal signs. It can optionally be configured to use smart logic. Syntax behavior for smart and non-smart variants of mark models that of BetterEm.

To Mark some text, simply surround the text with double =.

Marking

==mark me==

==smart==mark==

mark me

smartmark==

The Mark extension can be included in Python Markdown by using the following:

import markdown
md = markdown.Markdown(extensions=['pymdownx.mark'])

Tip

PyMdown Extensions uses one delimiter processor for emphasis, deletions, insertions, subscripts, superscripts and marks via BetterEm, Tilde, Caret, and Mark. This allows all delimiter to be parsed simultaneously providing the best nesting logic. So for best results, pair Caret with BetterEm.

import markdown
md = markdown.Markdown(extensions=['pymdownx.betterem', 'pymdownx.mark'])

Options

Option	Type	Default	Description
`smart_mark`	bool	`False`	Use smart logic with mark characters.