This is the documentation for the unsupported version 2.1. Please consider upgrading your code to the latest stable version

Changelog

All notable changes made in 2.x releases are shown below. See the full list of releases for the complete changelog.

2.4.1 - 2023-08-30

Fixed

• Fixed ExternalLinkProcessor not fully disabling the rel attribute when configured to do so (#992)

2.4.0 - 2023-03-24

See the upgrading guide for more information about the exception-related changes

Added

• Added generic CommonMarkException marker interface for all exceptions thrown by the library
• Added several new specific exception types implementing that marker interface:
  • AlreadyInitializedException
  • InvalidArgumentException
  • IOException
  • LogicException
  • MissingDependencyException
  • NoMatchingRendererException
  • ParserLogicException
• Added more configuration options to the Heading Permalinks extension (#939):
  • heading_permalink/apply_id_to_heading - When true, the id attribute will be applied to the heading element itself instead of the <a> tag
  • heading_permalink/heading_class - class to apply to the heading element
  • heading_permalink/insert - now accepts none to prevent the creation of the <a> link
• Added new table/alignment_attributes configuration option to control how table cell alignment is rendered (#959)

Changed

• Change several thrown exceptions from RuntimeException to LogicException (or something extending it), including:
  • CallbackGenerators that fail to set a URL or return an expected value
  • MarkdownParser when deactivating the last block parser or attempting to get an active block parser when they’ve all been closed
  • Adding items to an already-initialized Environment
  • Rendering a Node when no renderer has been registered for it
• HeadingPermalinkProcessor now throws InvalidConfigurationException instead of RuntimeException when invalid config values are given.
• HtmlElement::setAttribute() no longer requires the second parameter for boolean attributes
• Several small micro-optimizations
• Changed Strikethrough to only allow 1 or 2 tildes per the updated GFM spec

Fixed

• Fixed inaccurate @throws docblocks throughout the codebase, including ConverterInterface, MarkdownConverter, and MarkdownConverterInterface.
  • These previously suggested that only \RuntimeExceptions were thrown, which was inaccurate as \LogicExceptions were also possible.

2.3.9 - 2023-02-15

Fixed

• Fixed autolink extension not detecting some URIs with underscores (#956)

2.3.8 - 2022-12-10

Fixed

• Fixed parsing issues when mb_internal_encoding() is set to something other than UTF-8 (#951)

2.3.7 - 2022-11-17

Fixed

• Fixed TaskListItemMarkerRenderer not including HTML attributes set on the node by other extensions (#947)

2.3.6 - 2022-10-30

Fixed

• Fixed unquoted attribute parsing when closing curly brace is followed by certain characters (like a .) (#943)

2.3.5 - 2022-07-29

Fixed

• Fixed error using InlineParserEngine when no inline parsers are registered in the Environment (#908)

2.3.4 - 2022-07-17

Changed

• Made a number of small tweaks to the embed extension’s parsing behavior to fix #898:
  • Changed EmbedStartParser to always capture embed-like lines in container blocks, regardless of parent block type
  • Changed EmbedProcessor to also remove Embed blocks that aren’t direct children of the Document
  • Increased the priority of EmbedProcessor to 1010

Fixed

• Fixed EmbedExtension not parsing embeds following a list block (#898)

2.3.3 - 2022-06-07

Fixed

• Fixed DomainFilteringAdapter not reindexing the embed list (#884, #885)

2.3.2 - 2022-06-03

Fixed

• Fixed FootnoteExtension stripping extra characters from tab-indented footnotes (#881)

2.2.5 - 2022-06-03

Fixed

• Fixed FootnoteExtension stripping extra characters from tab-indented footnotes (#881)

2.3.1 - 2022-05-14

Fixed

• Fixed AutolinkExtension not ignoring trailing strikethrough syntax (#867)

2.2.4 - 2022-05-14

Fixed

• Fixed AutolinkExtension not ignoring trailing strikethrough syntax (#867)

2.3.0 - 2022-04-07

Added

• Added new EmbedExtension (#805)
• Added DocumentRendererInterface as a replacement for the now-deprecated MarkdownRendererInterface

Deprecated

• Deprecated MarkdownRendererInterface; use DocumentRendererInterface instead

2.2.3 - 2022-02-26

Fixed

• Fixed front matter parsing with Windows line endings (#821)

2.1.3 - 2022-02-26

Fixed

• Fixed front matter parsing with Windows line endings (#821)

2.2.2 - 2022-02-13

Fixed

• Fixed double-escaping of image alt text (#806, #810)
• Fixed Psalm typehints for event class names

2.1.2 - 2022-02-13

Fixed

• Fixed double-escaping of image alt text (#806, #810)
• Fixed Psalm typehints for event class names

2.2.1 - 2022-01-25

Fixed

• Fixed symfony/deprecation-contracts constraint

Removed

• Removed deprecation trigger from MarkdownConverterInterface to reduce noise

2.2.0 - 2022-01-22

Added

• Added new ConverterInterface
• Added new MarkdownToXmlConverter class
• Added new HtmlDecorator class which can wrap existing renderers with additional HTML tags
• Added new table/wrap config to apply an optional wrapping/container element around a table (#780)

Changed

• HtmlElement contents can now consist of any Stringable, not just HtmlElement and string

Deprecated

• Deprecated MarkdownConverterInterface and its convertToHtml() method; use ConverterInterface and convert() instead

2.1.1 - 2022-01-02

Added

• Added missing return type to Environment::dispatch() to fix deprecation warning (#778)

2.1.0 - 2021-12-05

Added

• Added support for ext-yaml in FrontMatterExtension (#715)
• Added support for symfony/yaml v6.0 in FrontMatterExtension (#739)
• Added new heading_permalink/aria_hidden config option (#741)

Fixed

• Fixed PHP 8.1 deprecation warning (#759, #762)

Older Versions

Please see the full list of releases for the complete changelog.

Edit this page