Release Notes

2.5.3 - 2024-08-16

Changed

• Made compatible with CommonMark spec 0.31.1, including:
  • Remove source, add search to list of recognized block tags

Full Changelog: https://github.com/thephpleague/commonmark/compare/2.5.2…2.5.3

2.5.2 - 2024-08-14

Changed

• Boolean attributes now require an explicit true value (#1040)

Fixed

• Fixed regression where text could be misinterpreted as an attribute (#1040)

Full Changelog: https://github.com/thephpleague/commonmark/compare/2.5.1…2.5.2

2.5.1 - 2024-07-24

Fixed

• Fixed attribute parsing incorrectly parsing mustache-like syntax (#1035)
• Fixed incorrect Table start line numbers (#1037)

New Contributors

• @jasonvarga made their first contribution in https://github.com/thephpleague/commonmark/pull/1035

Full Changelog: https://github.com/thephpleague/commonmark/compare/2.5.0…2.5.1

2.5.0 - 2024-07-22

Added

• The AttributesExtension now supports attributes without values (#985, #986)
• The AutolinkExtension exposes two new configuration options to override the default behavior (#969, #987):
  • autolink/allowed_protocols - an array of protocols to allow autolinking for
  • autolink/default_protocol - the default protocol to use when none is specified

Changed

• Made compatible with CommonMark spec 0.31.0, including:
  • Allow closing fence to be followed by tabs
  • Remove restrictive limitation on inline comments
  • Unicode symbols now treated like punctuation (for purposes of flankingness)
  • Trailing tabs on the last line of indented code blocks will be excluded
  • Improved HTML comment matching
• Paragraphs only containing link reference definitions will be kept in the AST until the Document is finalized
  • (These were previously removed immediately after parsing the Paragraph)

Fixed

• Fixed list tightness not being determined properly in some edge cases
• Fixed incorrect ending line numbers for several block types in various scenarios
• Fixed lowercase inline HTML declarations not being accepted

New Contributors

• @svenluijten made their first contribution in https://github.com/thephpleague/commonmark/pull/986

Full Changelog: https://github.com/thephpleague/commonmark/compare/2.4.4…2.5.0

2.4.4 - 2024-07-22

Fixed

• Fixed SmartPunct extension changing already-formatted quotation marks (#1030)

Full Changelog: https://github.com/thephpleague/commonmark/compare/2.4.3…2.4.4

2.4.3 - 2024-07-22

Fixed

• Fixed the Attributes extension not supporting CSS level 3 selectors (#1013)
• Fixed UrlAutolinkParser incorrectly parsing text containing www anywhere before an autolink (#1025)

New Contributors

• @nfreader made their first contribution in https://github.com/thephpleague/commonmark/pull/1016
• @macbookandrew made their first contribution in https://github.com/thephpleague/commonmark/pull/1025
• @xavierlacot made their first contribution in https://github.com/thephpleague/commonmark/pull/1013

Full Changelog: https://github.com/thephpleague/commonmark/compare/2.4.2…2.4.3

2.4.2 - 2024-02-02

Fixed

• Fixed declaration parser being too strict
• FencedCodeRenderer: don’t add language- to class if already prefixed

New Contributors

• @sergiy-petrov made their first contribution in https://github.com/thephpleague/commonmark/pull/997
• @clustermin made their first contribution in https://github.com/thephpleague/commonmark/pull/988
• @peter279k made their first contribution in https://github.com/thephpleague/commonmark/pull/996

Full Changelog: https://github.com/thephpleague/commonmark/compare/2.4.1…2.4.2

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.0.4 - 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.0.3 - 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

1.6.7 - 2022-01-13

Changed

• Added ReturnTypeWillChange attribute to prevent PHP 8.1 deprecation warnings (#785)
• Coerced punctuation counts to integers to ensure floats are never used

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)

2.0.2 - 2021-08-14

Changed

• Bumped minimum version of league/config to support PHP 8.1

Fixed

• Fixed ability to register block parsers that identify lines starting with letters (#706)

2.0.1 - 2021-07-31

Fixed

• Fixed nested autolinks (#689)
• Fixed description lists being parsed incorrectly (#692)
• Fixed Table of Contents not respecting Heading Permalink prefixes (#690)

2.0.0 - 2021-07-24

No changes were introduced since the previous 2.0.0-rc2 release.

Please refer to the full Changelog for a list of all changes between 1.x and 2.0. An upgrading guide is also available.

2.0.0-rc2 - 2021-07-17

Fixed

• Fixed Mentions inside of links creating nested links against the spec’s rules (#688)

1.6.6 - 2021-07-17

Fixed

• Fixed Mentions inside of links creating nested links against the spec’s rules (#688)

2.0.0-rc1 - 2021-07-10

No changes were introduced since the previous release.

2.0.0-beta3 - 2021-07-03

Changed

• Any leading UTF-8 BOM will be stripped from the input
• The getEnvironment() method of CommonMarkConverter and GithubFlavoredMarkdownConverter will always return the concrete, configurable Environment for upgrading convenience
• Optimized AST iteration
• Lots of small micro-optimizations

2.0.0-beta2 - 2021-06-27

See https://commonmark.thephpleague.com/2.0/upgrading/ for detailed information on upgrading to version 2.0.

Added

• Added new Node::iterator() method and NodeIterator class for faster AST iteration (#683, #684)

Changed

• Made compatible with CommonMark spec 0.30.0
• Optimized link label parsing
• Optimized AST iteration for a 50% performance boost in some event listeners (#683, #684)

Fixed

• Fixed processing instructions with EOLs
• Fixed case-insensitive matching for HTML tag types
• Fixed type 7 HTML blocks incorrectly interrupting lazy paragraphs
• Fixed newlines in reference labels not collapsing into spaces
• Fixed link label normalization with escaped newlines
• Fixed unnecessary AST iteration when no default attributes are configured

1.6.5 - 2021-06-26

Changed

• Simplified checks for thematic breaks

Fixed

• Fixed ExternalLinkProcessor not handling autolinks by adjusting its priority to -50 (#681)

2.0.0-beta1 - 2021-06-20

See https://commonmark.thephpleague.com/2.0/upgrading/ for detailed information on upgrading to version 2.0.

Added

• Added three new extensions:
  • FrontMatterExtension (see documentation)
  • DescriptionListExtension (see documentation)
  • DefaultAttributesExtension (see documentation)
• Added new XmlRenderer to simplify AST debugging (see documentation) (#431)
• Added the ability to configure disallowed raw HTML tags (#507)
• Added the ability for Mentions to use multiple characters for their symbol (#514, #550)
• Added the ability to delegate event dispatching to PSR-14 compliant event dispatcher libraries
• Added new configuration options:
  • Added heading_permalink/min_heading_level and heading_permalink/max_heading_level options to control which headings get permalinks (#519)
  • Added heading_permalink/fragment_prefix to allow customizing the URL fragment prefix (#602)
  • Added footnote/backref_symbol option for customizing backreference link appearance (#522)
  • Added slug_normalizer/max_length option to control the maximum length of generated URL slugs
  • Added slug_normalizer/unique option to control whether unique slugs should be generated per-document or per-environment
• Added purity markers throughout the codebase (verified with Psalm)
• Added Query class to simplify Node traversal when looking to take action on certain Nodes
• Added new HtmlFilter and StringContainerHelper utility classes
• Added new AbstractBlockContinueParser class to simplify the creation of custom block parsers
• Added several new classes and interfaces:
  • BlockContinue
  • BlockContinueParserInterface
  • BlockContinueParserWithInlinesInterface
  • BlockStart
  • BlockStartParserInterface
  • ChildNodeRendererInterface
  • ConfigurableExtensionInterface
  • CursorState
  • DashParser (extracted from PunctuationParser)
  • DelimiterParser
  • DocumentBlockParser
  • DocumentPreRenderEvent
  • DocumentRenderedEvent
  • EllipsesParser (extracted from PunctuationParser)
  • ExpressionInterface
  • FallbackNodeXmlRenderer
  • InlineParserEngineInterface
  • InlineParserMatch
  • MarkdownParserState
  • MarkdownParserStateInterface
  • MarkdownRendererInterface
  • Query
  • RawMarkupContainerInterface
  • ReferenceableInterface
  • RenderedContent
  • RenderedContentInterface
  • ReplaceUnpairedQuotesListener
  • SpecReader
  • TableOfContentsRenderer
  • UniqueSlugNormalizer
  • UniqueSlugNormalizerInterface
  • XmlRenderer
  • XmlNodeRendererInterface
• Added several new methods:
  • Cursor::getCurrentCharacter()
  • Environment::createDefaultConfiguration()
  • Environment::setEventDispatcher()
  • EnvironmentInterface::getExtensions()
  • EnvironmentInterface::getInlineParsers()
  • EnvironmentInterface::getSlugNormalizer()
  • FencedCode::setInfo()
  • Heading::setLevel()
  • HtmlRenderer::renderDocument()
  • InlineParserContext::getFullMatch()
  • InlineParserContext::getFullMatchLength()
  • InlineParserContext::getMatches()
  • InlineParserContext::getSubMatches()
  • LinkParserHelper::parsePartialLinkLabel()
  • LinkParserHelper::parsePartialLinkTitle()
  • Node::assertInstanceOf()
  • RegexHelper::isLetter()
  • StringContainerInterface::setLiteral()
  • TableCell::getType()
  • TableCell::setType()
  • TableCell::getAlign()
  • TableCell::setAlign()

Changed

• Changed the converter return type
  • CommonMarkConverter::convertToHtml() now returns an instance of RenderedContentInterface. This can be cast to a string for backward compatibility with 1.x.
• Table of Contents items are no longer wrapped with <p> tags (#613)
• Heading Permalinks now link to element IDs instead of using name attributes (#602)
• Heading Permalink IDs and URL fragments now have a content prefix by default (#602)
• Changes to configuration options:
  • enable_em has been renamed to commonmark/enable_em
  • enable_strong has been renamed to commonmark/enable_strong
  • use_asterisk has been renamed to commonmark/use_asterisk
  • use_underscore has been renamed to commonmark/use_underscore
  • unordered_list_markers has been renamed to commonmark/unordered_list_markers
  • mentions/*/symbol has been renamed to mentions/*/prefix
  • mentions/*/regex has been renamed to mentions/*/pattern and requires partial regular expressions (without delimiters or flags)
  • max_nesting_level now defaults to PHP_INT_MAX and no longer supports floats
  • heading_permalink/slug_normalizer has been renamed to slug_normalizer/instance
• Event dispatching is now fully PSR-14 compliant
• Moved and renamed several classes - see the full list here
• The HeadingPermalinkExtension and FootnoteExtension were modified to ensure they never produce a slug which conflicts with slugs created by the other extension
• SlugNormalizer::normalizer() now supports optional prefixes and max length options passed in via the $context argument
• The AbstractBlock::$data and AbstractInline::$data arrays were replaced with a Data array-like object on the base Node class
• Implemented a new approach to block parsing. This was a massive change, so here are the highlights:
  • Functionality previously found in block parsers and node elements has moved to block parser factories and block parsers, respectively (more details)
  • ConfigurableEnvironmentInterface::addBlockParser() is now EnvironmentBuilderInterface::addBlockParserFactory()
  • ReferenceParser was re-implemented and works completely different than before
  • The paragraph parser no longer needs to be added manually to the environment
• Implemented a new approach to inline parsing where parsers can now specify longer strings or regular expressions they want to parse (instead of just single characters):
  • InlineParserInterface::getCharacters() is now getMatchDefinition() and returns an instance of InlineParserMatch
  • InlineParserContext::__construct() now requires the contents to be provided as a Cursor instead of a string
• Implemented delimiter parsing as a special type of inline parser (via the new DelimiterParser class)
• Changed block and inline rendering to use common methods and interfaces
  • BlockRendererInterface and InlineRendererInterface were replaced by NodeRendererInterface with slightly different parameters. All core renderers now implement this interface.
  • ConfigurableEnvironmentInterface::addBlockRenderer() and addInlineRenderer() were combined into EnvironmentBuilderInterface::addRenderer()
  • EnvironmentInterface::getBlockRenderersForClass() and getInlineRenderersForClass() are now just getRenderersForClass()
• Completely refactored the Configuration implementation
  • All configuration-specific classes have been moved into a new league/config package with a new namespace
  • Configuration objects must now be configured with a schema and all options must match that schema - arbitrary keys are no longer permitted
  • Configuration::__construct() no longer accepts the default configuration values - use Configuration::merge() instead
  • ConfigurationInterface now only contains a get(string $key); this method no longer allows arbitrary default values to be returned if the option is missing
  • ConfigurableEnvironmentInterface was renamed to EnvironmentBuilderInterface
  • ExtensionInterface::register() now requires an EnvironmentBuilderInterface param instead of ConfigurableEnvironmentInterface
• Added missing return types to virtually every class and interface method
• Re-implemented the GFM Autolink extension using the new inline parser approach instead of document processors
  • EmailAutolinkProcessor is now EmailAutolinkParser
  • UrlAutolinkProcessor is now UrlAutolinkParser
• HtmlElement can now properly handle array (i.e. class) and boolean (i.e. checked) attribute values
• HtmlElement automatically flattens any attributes with array values into space-separated strings, removing duplicate entries
• Combined separate classes/interfaces into one:
  • DisallowedRawHtmlRenderer replaces DisallowedRawHtmlBlockRenderer and DisallowedRawHtmlInlineRenderer
  • NodeRendererInterface replaces BlockRendererInterface and InlineRendererInterface
• Renamed the following methods:
  • Environment and ConfigurableEnvironmentInterface:
    • addBlockParser() is now addBlockStartParser()
  • ReferenceMap and ReferenceMapInterface:
    • addReference() is now add()
    • getReference() is now get()
    • listReferences() is now getIterator()
  • Various node (block/inline) classes:
    • getContent() is now getLiteral()
    • setContent() is now setLiteral()
• Moved and renamed the following constants:
  • EnvironmentInterface::HTML_INPUT_ALLOW is now HtmlFilter::ALLOW
  • EnvironmentInterface::HTML_INPUT_ESCAPE is now HtmlFilter::ESCAPE
  • EnvironmentInterface::HTML_INPUT_STRIP is now HtmlFilter::STRIP
  • TableCell::TYPE_HEAD is now TableCell::TYPE_HEADER
  • TableCell::TYPE_BODY is now TableCell::TYPE_DATA
• Changed the visibility of the following properties:
  • AttributesInline::$attributes is now private
  • AttributesInline::$block is now private
  • TableCell::$align is now private
  • TableCell::$type is now private
  • TableSection::$type is now private
• Several methods which previously returned $this now return void
  • Delimiter::setPrevious()
  • Node::replaceChildren()
  • Context::setTip()
  • Context::setContainer()
  • Context::setBlocksParsed()
  • AbstractStringContainer::setContent()
  • AbstractWebResource::setUrl()
• Several classes are now marked final:
  • ArrayCollection
  • Emphasis
  • FencedCode
  • Heading
  • HtmlBlock
  • HtmlElement
  • HtmlInline
  • IndentedCode
  • Newline
  • Strikethrough
  • Strong
  • Text
• Heading nodes no longer directly contain a copy of their inner text
• StringContainerInterface can now be used for inlines, not just blocks
• ArrayCollection only supports integer keys
• HtmlElement now implements Stringable
• Cursor::saveState() and Cursor::restoreState() now use CursorState objects instead of arrays
• NodeWalker::next() now enters, traverses any children, and leaves all elements which may have children (basically all blocks plus any inlines with children). Previously, it only did this for elements explicitly marked as “containers”.
• InvalidOptionException was removed
• Anything with a getReference(): ReferenceInterface method now implements ReferencableInterface
• The SmartPunct extension now replaces all unpaired Quote elements with Text elements towards the end of parsing, making the QuoteRenderer unnecessary
• Several changes made to the Footnote extension:
  • Footnote identifiers can no longer contain spaces
  • Anonymous footnotes can now span subsequent lines
  • Footnotes can now contain multiple lines of content, including sub-blocks, by indenting them
  • Footnote event listeners now have numbered priorities (but still execute in the same order)
  • Footnotes must now be separated from previous content by a blank line
• The line numbers (keys) returned via MarkdownInput::getLines() now start at 1 instead of 0
• DelimiterProcessorCollectionInterface now extends Countable
• RegexHelper::PARTIAL_ constants must always be used in case-insensitive contexts
• HeadingPermalinkProcessor no longer accepts text normalizers via the constructor - these must be provided via configuration instead
• Blocks which can’t contain inlines will no longer be asked to render inlines
• AnonymousFootnoteRefParser and HeadingPermalinkProcessor now implement EnvironmentAwareInterface instead of ConfigurationAwareInterface
• The second argument to TextNormalizerInterface::normalize() must now be an array
• The title attribute for Link and Image nodes is now stored using a dedicated property instead of stashing it in $data
• ListData::$delimiter now returns either ListBlock::DELIM_PERIOD or ListBlock::DELIM_PAREN instead of the literal delimiter

Fixed

• Fixed parsing of footnotes without content
• Fixed rendering of orphaned footnotes and footnote refs
• Fixed some URL autolinks breaking too early (#492)
• Fixed AbstractStringContainer not actually being abstract

Removed

• Removed support for PHP 7.1, 7.2, and 7.3 (#625, #671)
• Removed all previously-deprecated functionality:
  • Removed the ability to pass custom Environment instances into the CommonMarkConverter and GithubFlavoredMarkdownConverter constructors
  • Removed the Converter class and ConverterInterface
  • Removed the bin/commonmark script
  • Removed the Html5Entities utility class
  • Removed the InlineMentionParser (use MentionParser instead)
  • Removed DefaultSlugGenerator and SlugGeneratorInterface from the Extension/HeadingPermalink/Slug sub-namespace (use the new ones under ./SlugGenerator instead)
  • Removed the following ArrayCollection methods:
    • add()
    • set()
    • get()
    • remove()
    • isEmpty()
    • contains()
    • indexOf()
    • containsKey()
    • replaceWith()
    • removeGaps()
  • Removed the ConfigurableEnvironmentInterface::setConfig() method
  • Removed the ListBlock::TYPE_UNORDERED constant
  • Removed the CommonMarkConverter::VERSION constant
  • Removed the HeadingPermalinkRenderer::DEFAULT_INNER_CONTENTS constant
  • Removed the heading_permalink/inner_contents configuration option
• Removed now-unused classes:
  • AbstractStringContainerBlock
  • BlockRendererInterface
  • Context
  • ContextInterface
  • Converter
  • ConverterInterface
  • InlineRendererInterface
  • PunctuationParser (was split into two classes: DashParser and EllipsesParser)
  • QuoteRenderer
  • UnmatchedBlockCloser
• Removed the following methods, properties, and constants:
  • AbstractBlock::$open
  • AbstractBlock::$lastLineBlank
  • AbstractBlock::isContainer()
  • AbstractBlock::canContain()
  • AbstractBlock::isCode()
  • AbstractBlock::matchesNextLine()
  • AbstractBlock::endsWithBlankLine()
  • AbstractBlock::setLastLineBlank()
  • AbstractBlock::shouldLastLineBeBlank()
  • AbstractBlock::isOpen()
  • AbstractBlock::finalize()
  • AbstractBlock::getData()
  • AbstractInline::getData()
  • ConfigurableEnvironmentInterface::addBlockParser()
  • ConfigurableEnvironmentInterface::mergeConfig()
  • Delimiter::setCanClose()
  • EnvironmentInterface::getConfig()
  • EnvironmentInterface::getInlineParsersForCharacter()
  • EnvironmentInterface::getInlineParserCharacterRegex()
  • HtmlRenderer::renderBlock()
  • HtmlRenderer::renderBlocks()
  • HtmlRenderer::renderInline()
  • HtmlRenderer::renderInlines()
  • Node::isContainer()
  • RegexHelper::matchAll() (use the new matchFirst() method instead)
  • RegexHelper::REGEX_WHITESPACE
• Removed the second $contents argument from the Heading constructor

Deprecated

The following things have been deprecated and will not be supported in v3.0:

• Environment::mergeConfig() (set configuration before instantiation instead)
• Environment::createCommonMarkEnvironment() and Environment::createGFMEnvironment()
  • Alternative 1: Use CommonMarkConverter or GithubFlavoredMarkdownConverter if you don’t need to customize the environment
  • Alternative 2: Instantiate a new Environment and add the necessary extensions yourself

1.6.4 - 2021-06-19

Changed

• Optimized attribute parsing to avoid inspecting every space character (30% performance boost)

1.6.3 - 2021-06-19

Fixed

• Fixed incorrect parsing of tilde-fenced code blocks with leading spaces (#676)

1.6.2 - 2021-05-12

Fixed

• Fixed incorrect error level for deprecation notices

1.6.1 - 2021-05-08

Fixed

• Fixed HeadingPermalinkProcessor skipping text contents from certain nodes (#615)

1.6.0 - 2021-05-01

Please see https://commonmark.thephpleague.com/1.6/upgrading/ for important information about this release and the upcoming 2.0.0 version.

Added

• Added forward-compatibility for configuration options which will be changing in 2.0:
  • commonmark/enable_em (currently enable_em in 1.x)
  • commonmark/enable_strong (currently enable_strong in 1.x)
  • commonmark/use_asterisk (currently use_asterisk in 1.x)
  • commonmark/use_underscore (currently use_underscore in 1.x)
  • commonmark/unordered_list_markers (currently unordered_list_markers in 1.x)
  • mentions/*/prefix (currently mentions/*/symbol in 1.x)
  • mentions/*/pattern (currently mentions/*/regex in 1.x)
  • max_nesting_level (currently supports int and float values in 1.x; will only support int in 2.0)
• Added new MarkdownConverter class for creating converters with custom environments; this replaces the previously-deprecated Converter class
• Added new RegexHelper::matchFirst() method
• Added new Configuration::exists() method

Changed

• The max_nesting_level option now defaults to PHP_INT_MAX instead of INF

Deprecated

• Deprecated the configuration options shown above
• Deprecated the ability to pass a custom Environment into the constructors of CommonMarkConverter and GithubFlavoredMarkdownConverter; use MarkdownConverter instead
• Deprecated ConfigurableEnvironmentInterface::setConfig(); use mergeConfig() instead
• Deprecated calling ConfigurableEnvironmentInterface::mergeConfig() without any parameters
• Deprecated calling Configuration::get() and EnvironmentInterface::getConfig() without any parameters
• Deprecated calling Configuration::set() without the second $value parameter
• Deprecated RegexHelper::matchAll(); use RegexHelper::matchFirst() instead
• Deprecated extending the ArrayCollection class; will be marked final in 2.0

Fixed

• Fixed missing check for empty arrays being passed into the unordered_list_markers configuration option

1.5.8 - 2021-03-28

Fixed

• Fixed Table of Contents not rendering heading inlines properly (#587, #588)
• Fixed parsing of tables within list items (#590)

1.5.7 - 2020-10-31

Fixed

• Fixed mentions not being parsed when appearing after non-word characters (#582)

1.5.6 - 2020-10-17

Changed

• Blocks added outside of the parsing context now have their start/end line numbers defaulted to 0 to avoid type errors (#579)

Fixed

• Fixed replacement blocks not inheriting the start line number of the container they’re replacing (#579)
• Fixed Table of Contents blocks not having correct start/end line numbers (#579)

1.5.5 - 2020-09-13

Changed

• Bumped CommonMark spec compliance to 0.28.2

Fixed

• Fixed textarea elements not being treated as a type 1 HTML block (like script, style, or pre)
• Fixed autolink processor not handling other unmatched trailing parentheses

1.5.4 - 2020-08-18

Fixed

• Fixed footnote ID configuration not taking effect (#524, #530)
• Fixed heading permalink slugs not being unique (#531, #534)

1.5.3 - 2020-07-19

Fixed

• Fixed regression of multi-byte inline parser characters not being matched

1.5.2 - 2020-07-19

Changed

• Significantly improved performance of the inline parser regex

Fixed

• Fixed parent class lookups for non-existent classes on PHP 8 (#517)

1.5.1 - 2020-06-27

Fixed

• Fixed UTF-8 encoding not being checked in the UrlEncoder utility (#509) or the Cursor

1.5.0 - 2020-06-21

Added

• Added new AttributesExtension based on https://github.com/webuni/commonmark-attributes-extension (#474)
• Added new FootnoteExtension based on https://github.com/rezozero/commonmark-ext-footnotes (#474)
• Added new MentionExtension to replace InlineMentionParser with more flexibility and customization
• Added the ability to render TableOfContents nodes anywhere in a document (given by a placeholder)
• Added the ability to properly clone Node objects
• Added options to customize the value of rel attributes set via the ExternalLink extension (#476)
• Added a new heading_permalink/slug_normalizer configuration option to allow custom slug generation (#460)
• Added a new heading_permalink/symbol configuration option to replace the now deprecated heading_permalink/inner_contents configuration option (#505)
• Added SlugNormalizer and TextNormalizer classes to make normalization reusable by extensions (#485)
• Added new classes:
  • TableOfContentsGenerator
  • TableOfContentsGeneratorInterface
  • TableOfContentsPlaceholder
  • TableOfContentsPlaceholderParser
  • TableOfContentsPlaceholderRenderer

Changed

• “Moved” the TableOfContents class into a new Node sub-namespace (with backward-compatibility)
• Reference labels are now generated and stored in lower-case instead of upper-case
• Reference labels are no longer normalized inside the Reference, only the ReferenceMap

Fixed

• Fixed reference label case folding polyfill not being consistent between different PHP versions

Deprecated

• Deprecated the CommonMarkConverter::VERSION constant (#496)
• Deprecated League\CommonMark\Extension\Autolink\InlineMentionParser (use League\CommonMark\Extension\Mention\MentionParser instead)
• Deprecated everything under League\CommonMark\Extension\HeadingPermalink\Slug (use the classes under League\CommonMark\Normalizer instead)
• Deprecated League\CommonMark\Extension\TableOfContents\TableOfContents (use the one in the new Node sub-namespace instead)
• Deprecated the STYLE_ and NORMALIZE_ constants in TableOfContentsBuilder (use the ones in TableOfContentsGenerator instead)
• Deprecated the \League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkRenderer::DEFAULT_INNER_CONTENTS constant (#505)
• Deprecated the heading_permalink/inner_contents configuration option in the HeadingPermalink extension (use the new heading_permalink/symbol configuration option instead) (#505)

1.4.3 - 2020-05-04

Fixed

• Fixed certain Unicode letters, numbers, and marks not being preserved when generating URL slugs (#467)

1.4.2 - 2020-04-24

Fixed

• Fixed inline code blocks not be included within heading permalinks (#457)

1.4.1 - 2020-04-20

Fixed

• Fixed BC break caused by ConverterInterface alias not being used by some DI containers (#454)

1.4.0 - 2020-04-18

Added

• Added new Heading Permalink extension (#420)
• Added new Table of Contents extension (#441)
• Added new MarkdownConverterInterface as a long-term replacement for ConverterInterface (#439)
• Added new DocumentPreParsedEvent event (#427, #359, #399)
• Added new ListBlock::TYPE_BULLET constant as a replacement for ListBlock::TYPE_UNORDERED
• Added new MarkdownInput class and MarkdownInputInterface to handle pre-parsing and allow listeners to replace Markdown contents

Changed

• Block & inline renderers will now render child classes automatically (#222, #209)
• The ListBlock constants now use fully-lowercased values instead of titlecased values
• Significantly improved typing

Fixed

• Fixed loose comparison when checking for table alignment
• Fixed StaggeredDelimiterProcessor returning from a void function

Deprecated

• The Converter class has been deprecated; use CommonMarkConverter instead (#438, #439)
• The ConverterInterface has been deprecated; use MarkdownConverterInterface instead (#438, #439)
• The bin/commonmark script has been deprecated
• The following methods of ArrayCollection have been deprecated:
  • add()
  • set()
  • get()
  • remove()
  • isEmpty()
  • contains()
  • indexOf()
  • containsKey()
  • replaceWith()
  • removeGaps()
• The ListBlock::TYPE_UNORDERED constant has been deprecated, use ListBlock::TYPE_BULLET instead

1.3.4 - 2020-04-13

Fixed

• Fixed configuration/environment not being injected into event listeners when adding them via [$instance, 'method'] callable syntax (#440)

1.3.3 - 2020-04-05

Fixed

• Fixed event listeners not having the environment or configuration injected if they implemented the EnvironmentAwareInterface or ConfigurationAwareInterface (#423)

1.3.2 - 2020-03-25

Fixed

• Optimized URL normalization in cases where URLs don’t contain special characters (#417, #418)

1.3.1 - 2020-02-28

Fixed

• Fixed return types of Environment::createCommonMarkEnvironment() and Environment::createGFMEnvironment()

1.3.0 - 2020-02-09

ℹ️ Do you use league/commonmark-ext* packages? Those features are now included directly in this library! See #409 for details on making the switch.

Added

• Added (optional) full GFM support! 🎉🎉🎉 (#409)
• Added check to ensure Markdown input is valid UTF-8 (#401, #405)
• Added new unordered_list_markers configuration option (#408, #411)

Changed

• Introduced several micro-optimizations for a 5-10% performance boost

1.2.2 - 2020-01-16

This release contains the same changes as 1.1.3:

Fixed

• Fixed link parsing edge case (#403)

1.1.3 - 2020-01-16

Fixed

• Fixed link parsing edge case (#403)

1.2.1 - 2020-01-15

Changed

• Introduced several micro-optimizations, reducing the parse time by 8%

1.2.0 - 2020-01-09

Changed

• Removed URL decoding step before encoding (more performant and better matches the JS library)
• Removed redundant token from HTML tag regex

1.1.2 - 2019-12-10

Fixed

• Fixed URL normalization not handling non-UTF-8 sequences properly (#395, #396)

1.1.1 - 2019-11-11

Fixed

• Fixed handling of link destinations with unbalanced unescaped parens
• Fixed adding delimiters to stack which can neither open nor close a run

1.1.0 - 2019-10-31

Added

• Added a new Html5EntityDecoder class (#387)

Changed

• Improved performance by 10% (#389)
• Made entity decoding less memory-intensive (#386, #387)

Fixed

• Fixed PHP 7.4 compatibility issues

Deprecated

• Deprecated the Html5Entities class - use Html5EntityDecoder instead (#387)

1.0.0 - 2019-06-29

First stable release! 🎉

No code changes have been introduced since 1.0.0-rc1

1.0.0-rc1 - 2019-06-20

Added

• Extracted a ReferenceMapInterface from the ReferenceMap class
• Added optional ReferenceMapInterface parameter to the Document constructor

Changed

• Replaced all references to ReferenceMap with ReferenceMapInterface
• ReferenceMap::addReference() no longer returns $this

Fixed

• Fixed bug where elements with content of "0" wouldn’t be rendered (#376)

0.19.3 - 2019-06-18

Fixed

• Fixed bug where elements with content of "0" wouldn’t be rendered (#376)

1.0.0-beta4 - 2019-06-05

Added

• Added event dispatcher functionality (#359, #372)

Removed

• Removed DocumentProcessorInterface functionality in favor of event dispatching (#373)

1.0.0-beta3 - 2019-05-28

Changed

• Made the Delimiter class final and extracted a new DelimiterInterface
  • Modified most external usages to use this new interface
• Renamed three Delimiter methods:
  • getOrigDelims() renamed to getOriginalLength()
  • getNumDelims() renamed to getLength()
  • setNumDelims() renamed to setLength()
• Made additional classes final:
  • DelimiterStack
  • ReferenceMap
  • ReferenceParser
• Moved ReferenceParser into the Reference sub-namespace

Removed

• Removed unused Delimiter methods:
  • setCanOpen()
  • setCanClose()
  • setChar()
  • setIndex()
  • setInlineNode()
• Removed fluent interface from Delimiter (setter methods now have no return values)

1.0.0-beta2 - 2019-05-27

This beta release fixes a couple of items that were not addressed in the previous beta.

Changed

• DelimiterProcessorInterface::process() will accept any type of AbstractStringContainer now, not just Text nodes
• The Delimiter constructor, getInlineNode(), and setInlineNode() no longer accept generic Node elements - only AbstractStringContainers

Removed

• Removed all deprecated functionality:
  • The safe option (use html_input and allow_unsafe_links options instead)
  • All deprecated RegexHelper constants
  • DocParser::getEnvironment() (you should obtain it some other way)
  • AbstractInlineContainer (use AbstractInline instead and make isContainer() return true)

1.0.0-beta1 - 2019-05-26

See the upgrading guide for additional information.

Added

• Added proper support for delimiters, including custom delimiters
  • addDelimiterProcessor() added to ConfigurableEnvironmentInterface and Environment
• Basic delimiters no longer need custom parsers - they’ll be parsed automatically
• Added new methods:
  • AdjacentTextMerger::mergeTextNodesBetweenExclusive()
  • CommonMarkConveter::getEnvironment()
  • Configuration::set()
• Extracted some new interfaces from base classes:
  • DocParserInterface created from DocParser
  • ConfigurationInterface created from Configuration
  • ReferenceInterface created from Reference

Changed

• Renamed several methods of the Configuration class:
  • getConfig() renamed to get()
  • mergeConfig() renamed to merge()
  • setConfig() renamed to replace()
• Changed ConfigurationAwareInterface::setConfiguration() to accept the new ConfigurationInterface instead of the concrete class
• Renamed the AdjoiningTextCollapser class to AdjacentTextMerger
  • Replaced its collapseTextNodes() method with the new mergeChildNodes() method
• Made several classes final:
  • Configuration
  • DocParser
  • HtmlRenderer
  • InlineParserEngine
  • NodeWalker
  • Reference
  • All of the block/inline parsers and renderers
• Reduced visibility of several internal methods to private:
  • DelimiterStack::findEarliest()
  • All protected methods in InlineParserEngine
• Marked some classes and methods as @internal
• ElementRendererInterface now requires a public renderInline() method; added this to HtmlRenderer
• Changed InlineParserEngine::parse() to require an AbstractStringContainerBlock instead of the generic Node class
• Un-deprecated the CommonmarkConverter::VERSION constant
• The Converter constructor now requires an instance of DocParserInterface instead of the concrete DocParser
• Changed Emphasis, Strong, and AbstractWebResource to directly extend AbstractInline instead of the (now-deprecated) intermediary AbstractInlineContainer class

Fixed

• Fixed null errors when inserting sibling Nodes without parents
• Fixed NodeWalkerEvent not requiring a Node via its constructor
• Fixed Reference::normalizeReference() improperly converting to uppercase instead of performing proper Unicode case-folding
• Fixed strong emphasis delimiters not being preserved when enable_strong is set to false (it now works identically to enable_em)

Deprecated

• Deprecated DocParser::getEnvironment() (you should obtain it some other way)
• Deprecated AbstractInlineContainer (use AbstractInline instead and make isContainer() return true)

Removed

• Removed inline processor functionality now that we have proper delimiter support:
  • Removed addInlineProcessor() from ConfigurableEnvironmentInterface and Environment
  • Removed getInlineProcessors() from EnvironmentInterface and Environment
  • Removed EmphasisProcessor
  • Removed InlineProcessorInterface
• Removed EmphasisParser now that we have proper delimiter support
• Removed support for non-UTF-8-compatible encodings
  • Removed getEncoding() from ContextInterface
  • Removed getEncoding(), setEncoding(), and $encoding from Context
  • Removed getEncoding() and the second $encoding constructor param from Cursor
• Removed now-unused methods
  • Removed DelimiterStack::getTop() (no replacement)
  • Removed DelimiterStack::iterateByCharacters() (use the new processDelimiters() method instead)
  • Removed the protected DelimiterStack::findMatchingOpener() method

0.19.2 - 2019-05-19

Fixed

• Fixed bug where default values for nested configuration paths were inadvertently cast to strings

0.19.1 - 2019-04-11

0.19.1 is an immediate follow-up to 0.19.0 which fixes issues with extensions that register other extensions.

(While this technically introduces a BC-break, it’s allowed under SemVer’s rules for 0.x releases and is necessary for 0.19.x code to work as expected.)

Added

• Added the missing addExtension() method to the new ConfigurableEnvironmentInterface

Fixed

• Fixed extensions not being able to register other extensions

0.19.0 - 2019-04-11

The 50th release of league/commonmark is here! :tada:

The Environment and extension framework underwent some major changes in this release. Be sure to read the upgrade notes if you maintain any community extensions or have written custom functionality on top of this library.

Added

• The priority of parsers, processors, and renderers can now be set when add()ing them; you no longer need to rely on the order in which they are added
• Added support for trying multiple parsers per block/inline
• Extracted two new base interfaces from Environment:
  • EnvironmentInterface
  • ConfigurableEnvironmentInterface
• Extracted a new AbstractStringContainerBlock base class and corresponding StringContainerInterface from AbstractBlock
• Added Cursor::getEncoding() method
• Added .phpstorm.meta.php file for better IDE code completion
• Made some minor optimizations here and there

Changed

• Pretty much everything now has parameter and return types (#346)
• Attributes passed to HtmlElement will now be escaped by default
• Environment is now a final class
• Environment::getBlockRendererForClass() was replaced with Environment::getBlockRenderersForClass() (note the added s)
• Environment::getInlineRendererForClass() was replaced with Environment::getInlineRenderersForClass() (note the added s)
• The Environment::get____() methods now return an iterator instead of an array
• Context::addBlock() no longer returns the same block instance you passed into the method, as this served no useful purpose
• RegexHelper::isEscapable() no longer accepts null values
• Node::replaceChildren() now accepts any type of iterable, not just arrays
• Some block elements now extend AbstractStringContainerBlock instead of AbstractBlock
  • InlineContainerInterface now extends the new StringContainerInterface
  • The handleRemainingContents() method (formerly on AbstractBlock, now on AbstractStringContainerBlock) is now an `abstract method
  • The InlineParserContext constructor now requires an AbstractStringContainerBlock instead of an AbstractBlock

Removed

• Removed support for PHP 5.6 and 7.0 (#346)
• Removed support for add()ing parsers with just the target block/inline class name - you need to include the full namespace now
• Removed the following unused methods from Environment:
  • getInlineParser($name)
  • getInlineParsers()
  • createInlineParserEngine()
• Removed the unused getName() methods:
  • AbstractBlockParser::getName()
  • AbstractInlineParser::getName()
  • BlockParserInterface::getName()
  • InlinerParserInterface::getName()
• Removed the now-useless classes:
  • AbstractBlockParser
  • AbstractInlinerParser
  • InlineContainer
• Removed the AbstractBlock::acceptsLines() method
• Removed the now-useless constructor from AbstractBlock
• Removed previously-deprecated functionality:
  • InlineContainer class
  • RegexHelper::$instance
  • RegexHelper::getInstance()
  • RegexHelper::getPartialRegex()
  • RegexHelper::getHtmlTagRegex()
  • RegexHelper::getLinkTitleRegex()
  • RegexHelper::getLinkDestinationBracesRegex()
  • RegexHelper::getThematicBreakRegex()
• Removed the second $preserveEntities parameter from Xml:escape()

0.18.5 - 2019-04-09

Fixed

• Fixed the adjoining Text collapser not handling the full tree (thephpleague/commonmark-ext-autolink#10)

0.18.4 - 2019-03-24

Changed

• Modified how URL normalization decodes certain characters in order to align with the JS library’s output
• Disallowed unescaped ( in parenthesized link title

Fixed

• Fixed two exponential backtracking issues

0.18.3 - 2019-03-21

This is a security update release.

Changed

• XML/HTML entities in attributes will no longer be preserved when rendering (#353)

Fixed

• Fix XSS vulnerability caused by improper preservation of entities when rendering (#353)

Deprecated

• Deprecated the $preserveEntites argument of Xml::escape() for removal in the next release (#353)

0.18.2 - 2019-03-17

Fixed

• Fixed adjoining Text elements not being collapsed after delimiter processing

Deprecated

• Deprecated the CommonmarkConverter::VERSION constant for removal in 1.0.0

0.18.1 - 2018-12-30

This release contains an important security update for CVE-2018-20583.

Fixed

• Fix XSS vulnerability caused by URL normalization not handling/encoding newlines properly (#337, CVE-2018-20583)

0.18.0 - 2018-09-18

No breaking changes were introduced, but we did add a new interface: ConverterInterface. Consider depending on this interface in your code instead of the concrete implementation. (See #330)

Added

• Added ConverterInterface to Converter and CommonMarkConverter (#330)
• Added ListItem::getListData() method (#329)

Changed

• Links with target="_blank" will also get rel="noopener noreferrer" by default (#331)
• Implemented several performance optimizations (#324)

0.17.5 - 2018-03-29

Fixed

• Fixed incorrect version constant value (again)
• Fixed release checklist to prevent the above from happening
• Fixed incorrect dates in CHANGELOG

0.17.4 - 2018-03-29

Added

• Added ListBlock::setTight() method

0.17.3 - 2018-03-26

Fixed

• Fixed incorrect version constant value (#322)

0.17.2 - 2018-03-26

Added

• Added new RegexHelper::isEscapable() method

Fixed

• Fixed spec compliance bug where escaped spaces should not be allowed in link destinations

0.17.1 - 2018-03-18

Added

• Added a new constant containing the current version: CommonMarkConverter::VERSION (#314)

0.17.0 - 2017-12-30

This release contains several breaking changes and a minimum PHP version bump - see UPGRADE.md for more details.

Added

• Added new max_nesting_level setting (#243)
• Added minor performance optimizations to Cursor

Changed

• Minimum PHP version is now 5.6.5.
• All full and partial regular expressions in RegexHelper are now defined as constants instead of being built on-the-fly.
• Cursor::saveState() now returns an array instead of a CursorState object.
• Cursor::restoreState() now accepts an array parameter instead of a CursorState object.
• Saving/restoring the Cursor state no longer tracks things that don’t change (like the text content).
• RegexHelper is now final.
• References to InlineContainer changed to new InlineContainerInterface interface.
• MiscExtension::addInlineParser() and MiscExtension::addBlockRenderer() now return $this instead of nothing.

Fixed

• Fixed Reference::normalizeReference() not properly collapsing whitespace to a single space

Deprecated

• RegexHelper::getInstance() and all instance (non-static) methods have been deprecated.
• The InlineContainer interface has been deprecated. Use InlineContainerInterface instead.

Removed

• Removed support for PHP 5.4 and 5.5.
• Removed CursorState class
• Removed all previous deprecations:
  • Cursor::getFirstNonSpacePosition()
  • Cursor::getFirstNonSpaceCharacter()
  • Cursor::advanceWhileMatches()
  • Cursor::advanceToFirstNonSpace()
  • ElementRendererInterface::escape()
  • HtmlRenderer::escape()
  • RegexHelper::REGEX_UNICODE_WHITESPACE
  • RegexHelper::getLinkDestinationRegex()

0.16.0 - 2017-10-31

This release contains breaking changes, several performance improvements, and two deprecations:

Added

• Added new Xml utility class; moved HTML/XML escaping logic into there (see deprecations below)

Changed

• Environment::getInlineParsersForCharacter() now returns an empty array (instead of null) when no matching parsers are found
• Three utility classes are now marked final:
  • Html5Entities
  • LinkParserHelper
  • UrlEncoder

Fixed

• Improved performance of several methods (for a 10% overall performance boost - #292)

Deprecated

The following methods were deprecated and are scheduled for removal in 0.17.0 or 1.0.0 (whichever comes first). See UPGRADE.md for more information.

• Cursor::advanceWhileMatches() deprecated; use Cursor::match() instead.
• HtmlRenderer::escape() deprecated; use Xml::escape() instead.

Removed

• Removed DelimiterStack::findFirstMatchingOpener() which was previously deprecated in 0.15.0

0.15.7 - 2017-10-26

Fixed

• Improved performance of Cursor::advanceBy() (for a 16% performance boost!) :tada:

0.15.6 - 2017-08-08

Fixed

• Fixed URI normalization not properly encoding/decoding special characters in certain cases (#287)

0.15.5 - 2017-08-05

This release bumps spec compliance to 0.28 without breaking changes to the API.

Added

• Project is now tested against PHP 7.2

Changed

• Bumped CommonMark spec target to 0.28
• Changed internal implementation of LinkParserHelper::parseLinkDestination() to allow nested parens
• Changed precedence of strong/emph when both nestings are possible (rule 14)
• Allow tabs before and after ATX closing header

Fixed

• Fixed HTML type 6 block regex matching against <pre> (it shouldn’t) and not matching <iframe> (it should)
• Fixed reference parser incorrectly handling escaped ] characters
• Fixed “multiple of 3” delimiter run calculations

Deprecated

An unused constant and static method were deprecated and will be removed in a future release. See for more information.

• Deprecated RegexHelper::REGEX_UNICODE_WHITESPACE (no longer used)
• Deprecated RegexHelper::getLinkDestinationRegex() (no longer used)

0.15.4 - 2017-05-09

Added

• Added new methods to Cursor (#280):
  • advanceToNextNonSpaceOrNewline() - Identical replacement for the (now-deprecated) advanceToFirstNonSpace() method
  • advanceToNextNonSpaceOrTab() - Similar replacement for advanceToFirstNonSpace() but with proper tab handling
  • getNextNonSpaceCharacter() - Identical replacement for the (now-deprecated) getFirstNonSpaceCharacter() method
  • getNextNonSpacePosition() - Identical replacement for the (now-deprecated) getFirstNonSpacePosition() method
• Added new method to CursorState (#280):
  • getNextNonSpaceCache() - Identical replacement for the (now-deprecated) getFirstNonSpaceCache() method

Fixed

• Fixed duplicate characters in non-intended lines containing tabs (#279)

Deprecated

All deprecations listed here will be removed in a future 0.x release. See UPGRADE.md for instructions on preparing your code for the eventual removal of these methods.

• Deprecated Cursor::advanceToFirstNonSpace() (#280)
  • Use advanceToNextNonSpaceOrTab() or advanceToNextNonSpaceOrNewline() instead, depending on your requirements
• Deprecated Cursor::getFirstNonSpaceCharacter() (#280)
  • Use Cursor::getNextNonSpaceCharacter() instead
• Deprecated Cursor::getFirstNonSpacePosition() (#280)
  • Use Cursor::getNextNonSpacePosition() instead
• Deprecated CursorState::getFirstNonSpaceCache() (#280)
  • Use CursorState::getNextNonSpaceCache() instead

0.15.3 - 2016-12-19

Fixed

• Allow inline parsers matching regex delimiter to be created (#271, #272)

0.15.2 - 2016-11-22

Changed

• Bumped spec target version to 0.27 (#268)
• H2-H6 elements are now parsed as HTML block elements instead of HTML inlines

Fixed

• Fixed incomplete punctuation regex
• Fixed shortcut links not being allowed before a (
• Fixed distinction between Unicode whitespace and regular whitespace

0.15.1 - 2016-11-08

Fixed

• Fixed setext heading underlines not allowing trailing tabs (#266)

0.15.0 - 2016-09-14

Added

• Added preliminary support for PHP 7.1 (#259)
• Added more regression tests (#258, #260)

Changed

• Bumped spec target version to 0.26 (#260)
• The CursorState constructor requires an additional parameter (#258)
• Ordered lists cannot interupt a paragraph unless they start with 1 (#260)
• Blank list items cannot interupt a paragraph (#260)

Deprecated

• Deprecated DelimiterStack::findFirstMatchingOpener() - use findMatchingOpener() instead (#260)

Fixed

• Fixed tabs in ATX headers and thematic breaks (#260)
• Fixed issue where cursor state was not being restored properly (#258, #260)
  • This fixed the lists-with-tabs regression reported in #258

Removed

• Removed an unnecessary check in Cursor::advanceBy() (#260)
• Removed the two-blanks-break-out-of-lists feature (#260)

0.14.0 - 2016-07-02

Added

• The safe option is deprecated and replaced by 2 new options (#253, #255):
  • html_input (strip, allow or escape): how to handle untrusted HTML input (the default is strip for BC reasons)
  • allow_unsafe_links (true or false): whether to allow risky image URLs and links (the default is true for BC reasons)

Deprecated

• The safe option is now deprecated and will be removed in the 1.0.0 release.

0.13.4 - 2016-06-14

Fixed

• Fixed path to autoload.php within bin/commonmark (#250)

0.13.3 - 2016-05-21

Added

• Added setUrl() method for Link and Image elements (#227, #244)
• Added cebe/markdown to the benchmark tool (#245)

0.13.2 - 2016-03-27

Added

• Added ability to invoke Converter as a function (#233, #239)
• Added new advanceBySpaceOrTab convenience method to Cursor

Changed

• Bumped spec target version to 0.25
• Adjusted how tabs are handled by the Cursor (#234)
• Made a couple small micro-optimizations to heavily used functions (#240)
• Updated URLs in docblocks to use HTTPS where possible (#238)

0.13.1 - 2016-03-09

Changed

• Refactored EmphasisParser::parse() to simplify it (#223)
• Updated dev dependencies (#218 & #220)

Fixed

• Fixed invalid regex generated when no inline parsers are defined (#224)
• Fixed logic bug with blank line after empty list item (#230)
• Fixed some incorrect code comments

Removed

• Removed unused variables (#223)

0.13.0 - 2016-01-14

Added

• Added AST document processors (#210)
• Added optional Environment parameter to CommonMarkConverter constructor

Changed

• Renamed “header” things to “heading” for spec consistency
  • Header => Heading
  • ATXHeaderParser => ATXHeadingParser
  • SetExtHeaderParser => SetExtHeadingParser
  • HeaderRenderer => HeadingRenderer
• Renamed “HorizontalRule” to “ThematicBreak” for spec consistency
  • HorizontalRule => ThematicBreak
  • HorizontalRuleParser => ThematicBreakParser
  • HorizontalRuleRenderer => ThematicBreakRenderer
  • HorizontalRuleRendererTest => ThematicBreakRendererTest
  • RegexHelper::getHRuleRegex() => RegexHelper::getThematicBreakRegex()
• Renamed inline “Html” and “RawHtml” to “HtmlInline” for consistency
  • Html => HtmlInline
  • RawHtmlParser => HtmlInlineParser
  • RawHtmlRenderer => HtmlInlineRenderer
• Don’t allow whitespace between link text and link label of a reference link (spec change)
• Don’t allow spaces in link destinations, even in <>
• Allow multiline setext header content
  • The Heading constructor now allows $contents to be a string (old behavior) or string[] (new)

Fixed

• Fixed several list issues and regressions (jgm/commonmark.js#59)

Removed

• Removed schema whitelist from autolink regex
• Moved SmartPunct functionality into new league/commonmark-extras package

0.12.0 - 2015-11-04

Added

• Added ability to configure characters and disable emphasis/strong (#135)
• Added new ConfigurationAwareInterface support for all parsers, processors, and renderers (#201)
• Added HTML safe mode to handle untrusted input (#200, #201)
  • Safe mode is disabled by default for backwards-compatibility
  • To enable it, set the safe option to true
• Added AppVeyor integration for automated unit/functional testing on Windows (#195)

Changed

• AbstractBlock::finalize() now reqires a second parameter, $endLineNumber
• RegexHelper::REGEX_ENTITY no longer includes the starting / or the ending /i (#194)
• Node::setParent() now accepts null values (#203)

Fixed

• Fixed incorrect endLine positions (#187)
• Fixed DocParser::preProcessInput dropping up to 2 ending newlines instead of just one
• Fixed EntityParser not checking for ampersands at the start of the current position (#192, #194)

Removed

• Removed protected function Context::addChild()
  • It was a duplicate of the Context::addBlock() method
• Disabled STDIN reading on bin/commonmark for Windows due to PHP issues (#189, #195)

0.11.3 - 2015-09-25

Fixed

• Reset container after closing containing lists (#183; jgm/commonmark.js#67)
  • The temporary fix from 0.11.2 was reverted

0.11.2 - 2015-09-23

Fixed

• Fixed parser checking acceptsLines on the wrong element (#183)

0.11.1 - 2015-09-22

Changed

• Tightened up some loose comparisons

Fixed

• Fixed missing “bin” directive in composer.json
• Updated a docblock to match recent changes to method parameters

Removed

• Removed unused variable from within QuoteProcessor’s closure

0.11.0 - 2015-09-19

This release contains several major internal changes. It will likely break compatibility with custom elements, parsers, and renderers. Simple Markdown parsing is unaffected.

Added

• Added new Node class, which both AbstractBlock and AbstractInline extend from (#169)
• Added a NodeWalker and NodeWalkerEvent to traverse the AST without using recursion
• Added new InlineContainer interface for blocks
• Added new getContainer() and getReferenceMap() methods to InlineParserContext
• Added iframe to whitelist of HTML block tags (as per spec)
• Added ./bin/commonmark for converting Markdown at the command line

Changed

• Bumped spec target version to 0.22
• Revised AST to use a double-linked list (#169)
• AbstractBlock and AbstractInline both extend from Node
  • Sub-classes must implement new isContainer() method
• Other major changes to AbstractBlock:
  • getParent() is now parent()
  • setParent() now expects a Node instead of an AbstractBlock
  • getChildren() is now children()
  • getLastChild() is now lastChild()
  • addChild() is now appendChild()
• InlineParserContext is constructed using the container AbstractBlock and the document’s RefereceMap
  • The constructor will automatically create the Cursor using the container’s string contents
• InlineParserEngine::parse now requires the Node container and the document’s ReferenceMap instead of a ContextInterface and Cursor
• Changed Delimiter to reference the actual inline Node instead of the position
  • The int $pos protected member and constructor arg is now Node $node
  • Use getInlineNode() and setInlineNode() instead of getPos() and setPos()
• Changed DocParser::processInlines to use a NodeWalker to iterate through inlines
  • Walker passed as second argument instead of AbstractBlock
  • Uses a while loop instead of recursion to traverse the AST
• Image and Link now only accept a string as their second argument
• Refactored how CloseBracketParser::parse() works internally
• CloseBracketParser::createInline no longer accepts label inlines
• Disallow list item starting with multiple blank lines (see jgm/CommonMark#332)
• Modified AbstractBlock::setLastLineBlank()
  • Functionality moved to AbstractBlock::shouldLastLineBeBlank() and new DocParser::setAndPropagateLastLineBlank() method
  • AbstractBlock::setLastLineBlank() is now a setter method for AbstractBlock::$lastLineBlank
• AbstractBlock::handleRemainingContents() is no longer abstract
  • A default implementation is provided
  • Removed duplicate code from sub-classes which used the default implementation - they’ll just use the parent method from now on

Fixed

• Fixed logic error in calculation of offset (see jgm/commonmark.js@94053a8)
• Fixed bug where DocParser checked the wrong method to determine remainder handling behavior
• Fixed bug where HorizontalRuleParser failed to advance the cursor beyond the parsed horizontal rule characters
• Fixed DocParser not ignoring the final newline of the input (like the reference parser does)

Removed

• Removed Block\Element\AbstractInlineContainer
  • Extend AbstractBlock and implement InlineContainer instead
  • Use child methods instead of getInlines and setInlines
• Removed AbstractBlock::replaceChild()
  • Call Node::replaceWith() directly the child node instead
• Removed the getInlines() method from InlineParserContext
  • Add parsed inlines using $inlineContext->getContainer()->appendChild() instead of $inlineContext->getInlines()->add()
• Removed the ContextInterface argument from AbstractInlineParser::parse() and InlineParserEngine::parseCharacter
• Removed the first ArrayCollection $inlines argument from InlineProcessorInterface::processInlines()
• Removed CloseBracketParser::nullify()
• Removed pre from rule 6 of HTML blocks (see jgm/CommonMark#355)

0.10.0 - 2015-07-25

Added

• Added parent references to inline elements (#124)
• Added smart punctuation extension (#134)
• Added HTML block types
• Added indentation caching to the cursor
• Added automated code style checks (#133)
• Added support for tag attributes in renderers (#101, #165)

Changed

• Bumped spec target version to 0.21
• Revised HTML block parsing to conform to new spec (jgm/commonmark.js@99bd473)
• Imposed 9-digit limit on ordered list markers, per spec
• Allow non-initial hyphens in html tag names (jgm/CommonMark#239)
• Updated list of block tag names
• Changed tab/indentation handling to meet the new spec behavior
• Modified spec tests to show spaces and tabs in test results
• Replaced HtmlRendererInterface with ElementRendererInterface (#141)
• Removed the unnecessary trim() and string cast from ListItemRenderer

Fixed

• Fixed link reference definition edge case (#120)
• Allow literal (non-escaping) backslashes in link destinations (#118)
• Allow backslash-escaped backslashes in link labels (#119)
• Allow link labels up to 999 characters (per the spec)
• Properly split on whitespace when determining code block class (jgm/commonmark.js#54)
• Fixed code style issues (#132, #133, #151, #152)
• Fixed wording for invalid inline exception (#136)

Removed

• Removed the advance-by-one optimization due to added cursor complexity

0.9.0 - 2015-06-19

Added

• Added public $data array to block elements (#95)
• Added isIndented helper method to Cursor
• Added a new Converter base class which CommonMarkConverter extends from (#105)

Changed

• Bumped spec target version to 0.20 (#112)
• Renamed ListBlock::$data and ListItem::$data to $listData
• Require link labels to contain non-whitespace (jgm/CommonMark#322)
• Use U+FFFD for entities resolving to 0 (jgm/CommonMark#323)
• Moved IndentedCodeParser::CODE_INDENT_LEVEL to Cursor::INDENT_LEVEL
• Changed arrays to short syntax (#116)
• Improved efficiency of DelimiterStack iteration (jgm/commonmark.js#43)

Fixed

• Fixed open block tag followed by newline not being recognized (jgm/CommonMark#324)
• Fixed indented lists sometimes being parsed incorrectly (jgm/commonmark.js#42)

0.8.0 - 2015-04-29

Added

• Allow swapping built-in renderers without using their fully qualified names (#84)
• Lots of unit tests (for existing code)
• Ability to include arbitrary functional tests in addition to spec-based tests

Changed

• Dropped support for PHP 5.3 (#64 and #76)
• Bumped spec target version to 0.19
• Made the AbstractInlineContainer be abstract
• Moved environment config. logic into separate class

Fixed

• Fixed underscore emphasis to conform to spec changes (jgm/CommonMark#317)

Removed

• Removed PHP 5.3 workaround (see commit 5747822)
• Removed unused AbstractWebResource::setUrl() method
• Removed unnecessary check for hrule when parsing lists (#85)

0.7.2 - 2015-03-08

Changed

• Bumped spec target version to 0.18

Fixed

• Fixed broken parsing of emphasized text ending with a ‘0’ character (#81)

0.7.1 - 2015-03-01

Added

• All references can now be obtained from the ReferenceMap via listReferences() (#73)
• Test against PHP 7.0 (nightly) but allow failures

Changed

• ListData::$start now defaults to null instead of 0 (#74)
• Replace references to HtmlRenderer with new HtmlRendererInterface

Fixed

• Fixed 0-based ordered lists starting at 1 instead of 0 (#74)
• Fixed errors parsing multi-byte characters (#78 and #79)

0.7.0 - 2015-02-17

Now with 50% more speed!

Added

• More unit tests to increase code coverage

Changed

• Enabled the InlineParserEngine to parse several non-special characters at once (performance boost)
• NewlineParser no longer attempts to parse spaces; look-behind is used instead (major performance boost)
• Moved closeUnmatchedBlocks into its own class
• Image and link elements now extend AbstractInlineContainer; label data is stored via $inlineContents instead
• Renamed AbstractInlineContainer::$inlineContents and its getter/setter

Removed

• Removed the InlineCollection class
• Removed the unused ArrayCollection::splice() method
• Removed impossible-to-reach code in Cursor::advanceToFirstNonSpace
• Removed unnecessary test from the InlineParserEngine
• Removed unnecessary/unused RegexHelper::getMainRegex() method

0.6.1 - 2015-01-25

Changed

• Bumped spec target version to 0.17
• Updated emphasis parsing for underscores to prevent intra-word emphasis
• Defered closing of fenced code blocks

0.6.0 - 2015-01-09

Added

• Bulk registration of parsers/renderers via extensions (#45)
• Proper UTF-8 support, especially in the Cursor; mbstring extension is now required (#49)
• Environment is now configurable; options can be accessed in its parsers/renderers (#56)
• Added some unit tests

Changed

• Bumped spec target version to 0.15 (#50)
• Parsers/renderers are now lazy-initialized (#52)
• Some private elements are now protected for easier extending, especially on Element classes (#53)
• Renderer option names changed from underscore_case to camelCase (#56)
• Moved CommonMark parser/render definitions into CommonMarkCoreExtension

Fixed

• Improved parsing of emphasis around punctuation
• Improved regexes for CDATA and HTML comments
• Fixed issue with HTML content that is considered false in loose comparisons, like '0' (#55)
• Fixed DocParser trying to add empty strings to closed containers (#58)
• Fixed incorrect use of a null parameter value in the HtmlElementTest

Removed

• Removed unused ReferenceDefinition* classes (#51)
• Removed UnicodeCaseFolder in favor of mb_strtoupper

0.5.1 - 2014-12-27

Fixed

• Fixed infinite loop and link-in-link-in-image parsing (#37)

Removed

• Removed hard dependency on mbstring extension; workaround used if not installed (#38)

0.5.0 - 2014-12-24

Added

• Support for custom directives, parsers, and renderers

Changed

• Major refactoring to de-couple directives from the parser, support custom directive functionality, and reduce complexity
• Updated references to stmd.js in README and docblocks
• Modified CHANGELOG formatting
• Improved travis configuration
• Put tests in autoload-dev

Fixed

• Fixed CommonMarkConverter re-creating object each time new text is converted (#26)

Removed

• Removed dependency on symfony/options-resolver (fixes #20)

- 2014-12-16

• Changed namespace to League\CommonMark
• Made compatible with spec version 0.13
• Moved delimiter stack functionality into seperate class
• Fixed regex which caused HHVM tests to fail
• Added some missing copyright info

Edit this page