markdown

Fixed

• Ensure nested elements inside inline comments are properly unescaped (#1571).
• Make the docs build successfully with mkdocstrings-python 2.0 (#1575).
• Fix infinite loop when multiple bogus or unclosed HTML comments appear in input (#1578).
• Fix another infinite loop when handling bad comments (#1586).

Fixed

• Fix codecs deprecation in Python 3.14.
• Fix issue with unclosed comment parsing in Python 3.14.
• Fix issue with unclosed declarations in Python 3.14.
• Fix issue with unclosed HTML tag <foo and Python 3.14.

Fixed

• Ensure incomplete markup declaration in raw HTML doesn't crash parser (#1534).
• Fixed dropped content in md_in_html (#1526).
• Fixed HTML handling corner case that prevented some content from not being rendered (#1528).

Changed

• DRY fix in abbr extension by introducing method create_element (#1483).
• Clean up test directory by removing some redundant tests and port
  non-redundant cases to the newer test framework.
• Improved performance of the raw HTML post-processor (#1510).

Fixed

• Backslash Unescape IDs set via attr_list on toc (#1493).
• Ensure md_in_html processes content inside "markdown" blocks as they are
  parsed outside of "markdown" blocks to keep things more consistent for
  third-party extensions (#1503).
• md_in_html handle tags within inline code blocks better (#1075).
• md_in_html fix handling of one-liner block HTML handling (#1074).
• Ensure <center> is treated like a block-level element (#1481).
• Ensure that abbr extension respects AtomicString and does not process
  perceived abbreviations in these strings (#1512).
• Ensure smarty extension correctly renders nested closing quotes (#1514).

Changed

Refactor abbr Extension

A new AbbrTreeprocessor has been introduced, which replaces the now deprecated
AbbrInlineProcessor. Abbreviation processing now happens after Attribute Lists,
avoiding a conflict between the two extensions (#1460).

The AbbrPreprocessor class has been renamed to AbbrBlockprocessor, which
better reflects what it is. AbbrPreprocessor has been deprecated.

A call to Markdown.reset() now clears all previously defined abbreviations.

Abbreviations are now sorted by length before executing AbbrTreeprocessor
to ensure that multi-word abbreviations are implemented even if an abbreviation
exists for one of those component words. (#1465)

Abbreviations without a definition are now ignored. This avoids applying
abbr tags to text without a title value.

Added an optional glossary configuration option to the abbreviations extension.
This provides a simple and efficient way to apply a dictionary of abbreviations
to every page.

Abbreviations can now be disabled by setting their definition to "" or ''.
This can be useful when using the glossary option.

Fixed

• Fixed links to source code on GitHub from the documentation (#1453).

Changed

Refactor TOC Sanitation

• All postprocessors are now run on heading content.
• Footnote references are now stripped from heading content. Fixes #660.
• A more robust striptags is provided to convert headings to plain text.
  Unlike, the markupsafe implementation, HTML entities are not unescaped.
• The plain text name, rich html, and unescaped raw data-toc-label are
  saved to toc_tokens, allowing users to access the full rich text content of
  the headings directly from toc_tokens.
• The value of data-toc-label is sanitized separate from heading content
  before being written to name. This fixes a bug which allowed markup through
  in certain circumstances. To access the raw unsanitized data, retrieve the
  value from token['data-toc-label'] directly.
• An html.unescape call is made just prior to calling slugify so that
  slugify only operates on Unicode characters. Note that html.unescape is
  not run on name, html, or data-toc-label.
• The functions get_name and stashedHTML2text defined in the toc extension
  are both deprecated. Instead, third party extensions should use some
  combination of the new functions run_postprocessors, render_inner_html and
  striptags.

Fixed

• Include scripts/*.py in the generated source tarballs (#1430).
• Ensure lines after heading in loose list are properly detabbed (#1443).
• Give smarty tree processor higher priority than toc (#1440).
• Permit carets (^) and square brackets (]) but explicitly exclude
  backslashes (\) from abbreviations (#1444).
• In attribute lists (attr_list, fenced_code), quoted attribute values are
  now allowed to contain curly braces (}) (#1414).

Fixed §

• Fix type annotations for convertFile - it accepts only bytes-based buffers. Also remove legacy checks from Python 2 ( #1400 )

• Remove legacy import needed only in Python 2 ( #1403 )

• Fix typo that left the attribute AdmonitionProcessor.content_indent unset ( #1404 )

• Fix edge-case crash in InlineProcessor with AtomicString ( #1406 ).

• Fix edge-case crash in codehilite with an empty code tag ( #1405 ).

• Improve and expand type annotations in the code base ( #1401 ).

• Fix handling of bogus comments ( #1425 ).

Fixed §

• Fix a performance problem with HTML extraction where large HTML input could trigger quadratic line counting behavior ( #1392 ).

• Improve and expand type annotations in the code base ( #1394 ).

Fixed §

• Add a special case for initial 's to smarty extension ( #1305 ).

• Unescape any backslash escaped inline raw HTML ( #1358 ).

• Unescape backslash escaped TOC token names ( #1360 ).

Fixed §

• Restore console script ( #1327 ).

Fixed §

• Officially support Python 3.11.

• Improve standalone * and _ parsing ( #1300 ).

• Consider <html> HTML tag a block-level element ( #1309 ).

• Switch from setup.py to pyproject.toml .

Fixed §

• Fix an import issue with importlib.util ( #1274 ).

Fixed §

• Disallow square brackets in reference link ids ( #1209 ).

• Retain configured pygments_style after first code block ( #1240 ).

• Ensure fenced code attributes are properly escaped ( #1247 ).

Fixed §

• Fix a dependency issue ( #1195 , #1196 ).

Fixed §

• Make the slugify_unicode function not remove diacritical marks ( #1118 ).

• Fix [toc] detection when used with nl2br extension ( #1160 ).

• Re-use compiled regex for block level checks ( #1169 ).

• Don’t process shebangs in fenced code blocks when using CodeHilite ( #1156 ).

• Improve email address validation for Automatic Links ( #1165 ).

• Ensure <summary> tags are parsed correctly ( #1079 ).

• Support Python 3.10 ( #1124 ).

Fixed §

• Properly parse unclosed tags in code spans ( #1066 ).

• Properly parse processing instructions in md_in_html ( #1070 ).

• Properly parse code spans in md_in_html ( #1069 ).

• Preserve text immediately before an admonition ( #1092 ).

• Simplified regex for HTML placeholders ( #928 ) addressing ( #932 ).

• Ensure permalinks and anchorlinks are not restricted by toc_depth ( #1107 ).

• Fix corner cases with lists under admonitions ( #1102 ).

Fixed §

• Unify all block-level tags ( #1047 ).

• Fix issue where some empty elements would have text rendered as None when using md_in_html ( #1049 ).

• Avoid catastrophic backtracking in hr regex ( #1055 ).

• Fix hr HTML handling ( #1053 ).

Fixed §

• Properly parse inline HTML in md_in_html ( #1040 & #1045 ).

• Avoid crashing when md_in_html fails ( #1040 ).

Fixed §

• Correctly parse raw script and style tags ( #1036 ).

• Ensure consistent class handling by fenced_code and codehilite ( #1032 ).

Fixed §

• Add checklinks tox environment to ensure all links in documentation are good.

• Refactor extension API documentation ( #729 ).

• Load entry_points (for extensions) only once using importlib.metadata .

• Do not double escape entities in TOC.

• Correctly report if an extension raises a TypeError ( #939 ).

• Raise a KeyError when attempting to delete a nonexistent key from the extension registry ( #939 ).

• Remove import of packaging (or pkg_resources fallback) entirely.

• Remove setuptools as a run-time dependency ( install_required ).

Fixed §

• The name property in toc_tokens from the TOC extension now escapes HTML special characters ( < , > , and & ).

Fixed §

• Fixed import failure in setup.py when the source directory is not on sys.path ( #823 ).

• Prefer public packaging module to pkg_resources’ private copy of it ( #825 ).

Fixed §

• Brought back the version and version_info variables ( #709 ).

• Added support for hexadecimal HTML entities ( #712 ).