2.4.0

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.