Skip to content

Commit

Permalink
Prepare to release 2.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
colinodell committed Mar 24, 2023
1 parent 5b0063b commit c6a7f9c
Show file tree
Hide file tree
Showing 42 changed files with 5 additions and 50 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi

## [Unreleased][unreleased]

## [2.4.0] - 2023-03-24

### Added

- Added generic `CommonMarkException` marker interface for all exceptions thrown by the library
Expand Down Expand Up @@ -552,7 +554,8 @@ No changes were introduced since the previous release.
- 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

[unreleased]: https://github.com/thephpleague/commonmark/compare/2.3.9...main
[unreleased]: https://github.com/thephpleague/commonmark/compare/2.4.0...main
[2.4.0]: https://github.com/thephpleague/commonmark/compare/2.3.9...2.4.0
[2.3.9]: https://github.com/thephpleague/commonmark/compare/2.3.8...2.3.9
[2.3.8]: https://github.com/thephpleague/commonmark/compare/2.3.7...2.3.8
[2.3.7]: https://github.com/thephpleague/commonmark/compare/2.3.6...2.3.7
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
},
"extra": {
"branch-alias": {
"dev-main": "2.4-dev"
"dev-main": "2.5-dev"
}
},
"config": {
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Basic Usage
description: Basic usage of the CommonMark parser
redirect_from: /basic-usage/
---

# Basic Usage
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Changelog
description: Important changes made in recent releases
redirect_from: /changelog/
---

# Changelog
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: default
title: Configuration
redirect_from: /configuration/
---

# Configuration
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/customization/abstract-syntax-tree.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Abstract Syntax Tree
description: Using the Abstract Syntax Tree (AST) to manipulate the parsed content
redirect_from: /customization/abstract-syntax-tree/
---

# Abstract Syntax Tree
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/customization/block-parsing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Block Parsing
description: How to parse block-level elements
redirect_from: /customization/block-parsing/
---

# Block Parsing
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/customization/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Configuration
description: Defining configuration schemas and accessing user-provided configuration options within your custom extensions
redirect_from: /customization/configuration/
---

# Configuration Schemas and Values
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/customization/cursor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Cursor
description: Using the Cursor object to parse Markdown content
redirect_from: /customization/cursor/
---

# Cursor
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/customization/delimiter-processing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Delimiter Processing
description: Processing CommonMark delimiter runs with a custom processor
redirect_from: /customization/delimiter-processing/
---

# Delimiter Processing
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/customization/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: The Environment
description: Configuring the CommonMark environment with custom options and added functionality
redirect_from: /customization/environment/
---

# The Environment
Expand Down
3 changes: 0 additions & 3 deletions docs/2.3/customization/event-dispatcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
layout: default
title: Event Dispatcher
description: How to leverage the event dispatcher to hook into the library
redirect_from:
- /customization/document-processing/
- /customization/event-dispatcher/
---

# Event Dispatcher
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/customization/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Extensions
description: Creating custom extensions to add new syntax and other custom functionality
redirect_from: /customization/extensions/
---

# Extensions
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/customization/inline-parsing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Inline Parsing
description: Parsing inline elements with a custom parser
redirect_from: /customization/inline-parsing/
---

# Inline Parsing
Expand Down
3 changes: 0 additions & 3 deletions docs/2.3/customization/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
layout: default
title: Customization Overview
description: An overview of the powerful customization features
redirect_from:
- /customization/
- /customization/overview/
---

# Customization Overview
Expand Down
3 changes: 0 additions & 3 deletions docs/2.3/customization/rendering.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
layout: default
title: Rendering
description: How to customize the rendering of block and inline elements
redirect_from:
- /customization/block-rendering/
- /customization/inline-rendering/
---

# Custom Rendering
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/customization/slug-normalizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Slug Normalizer
description: Using the Slug Normalizer to produce unique, URL-safe text strings
redirect_from: /customization/slug-normalizer/
---

# Slug Normalizer
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Attributes Extension
description: The AttributesExtension allows HTML attributes to be added from within the document.
redirect_from: /extensions/attributes/
---

# Attributes
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/autolinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Autolink Extension
description: The Autolink extension automatically converts URLs in plain text to clickable links
redirect_from: /extensions/autolinks/
---

# Autolink Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/commonmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: CommonMark Core Extension
description: The CommonMarkCoreExtension class includes all core Markdown syntax
redirect_from: /extensions/commonmark/
---

# CommonMark Core Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/default-attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Default Attributes Extension
description: The DefaultAttributesExtension allows you to apply default HTML classes and other attributes using configuration options.
redirect_from: /extensions/default-attributes/
---

# Default Attributes
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/description-lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Description List Extension
description: The Description List extension adds support for Markdown Extra-style <dl> lists
redirect_from: /extensions/description-lists/
---

# Description List Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/disallowed-raw-html.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Disallowed Raw HTML Extension
description: The DisallowedRawHtmlExtension automatically escapes certain HTML tags when rendering raw HTML
redirect_from: /extensions/disallowed-raw-html/
---

# Disallowed Raw HTML Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/embed.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Embed Extension
description: The EmbedExtension supports embedding rich content from other websites.
redirect_from: /extensions/embed/
---

# Embed Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/external-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: External Links Extension
description: The ExternalLinksExtension detects external links and adjusts their HTML markup
redirect_from: /extensions/external-links/
---

# External Links Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/footnotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Footnote Extension
description: The FootnoteExtension adds the ability to create footnotes in Markdown documents.
redirect_from: /extensions/footnotes/
---

# Footnotes
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/front-matter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Front Matter Extension
description: The Front Matter extension automatically parses YAML front matter from your Markdown.
redirect_from: /extensions/front-matter/
---

# Front Matter Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/github-flavored-markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: GitHub-Flavored Markdown
description: The GithubFlavoredMarkdownExtension class includes all the GFM addons
redirect_from: /extensions/github-flavored-markdown/
---

# GitHub-Flavored Markdown
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/heading-permalinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Heading Permalink Extension
description: The HeadingPermalinkExtension makes all header elements linkable
redirect_from: /extensions/heading-permalinks/
---

# Heading Permalink Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/inlines-only.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Inlines Only Extension
description: The InlinesOnlyExtension only enables parsing of inline elements
redirect_from: /extensions/inlines-only/
---

# Inlines Only Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/mentions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Mention Parser
description: The MentionParser makes it easy to parse shortened references like @colinodell and #123 to custom URLs
redirect_from: /extensions/mentions/
---

# Mention Extension
Expand Down
3 changes: 0 additions & 3 deletions docs/2.3/extensions/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
layout: default
title: Extensions Overview
description: An overview of the extensions included with this library
redirect_from:
- /extensions/
- /extensions/overview/
---

# Extensions Overview
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/smart-punctuation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Smart Punctuation Extension
description: The SmartPunctExtension intelligently converts ASCII quotes, dashes, and ellipses to their Unicode equivalents
redirect_from: /extensions/smart-punctuation/
---

# Smart Punctuation Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/strikethrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Strikethrough Extension
description: The StrikethroughExtension intelligently converts ASCII quotes, dashes, and ellipses to their Unicode equivalents
redirect_from: /extensions/strikethrough/
---

# Strikethrough Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/table-of-contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Table of Contents Extension
description: The Table of Contents extension automatically inserts links to the headings in your document.
redirect_from: /extensions/table-of-contents/
---

# Table of Contents Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Table Extension
description: The TableExtension adds the ability to create tables in CommonMark documents
redirect_from: /extensions/tables/
---

# Table Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/extensions/task-lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Task List Extension
description: The TaskListExtension adds support for GFM-style task lists
redirect_from: /extensions/task-lists/
---

# Task List Extension
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Installation
description: Instructions on how to install the league/commonmark library
redirect_from: /installation/
---

# Installation
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Security
description: How to configure league/commonmark against possible security issues when handling untrusted user input
redirect_from: /security/
---

# Security
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Support
description: Get help with the league/commonmark library
redirect_from: /support/
---

# Support
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: Upgrading from 2.2 to 2.3
description: Guide to upgrading to newer versions of this library
redirect_from: /upgrading/
---

# Upgrading from 2.2 to 2.3
Expand Down
1 change: 0 additions & 1 deletion docs/2.3/xml.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
layout: default
title: XML Rendering
description: Rendering Markdown documents in XML
redirect_from: /xml/
---

# XML Rendering
Expand Down

0 comments on commit c6a7f9c

Please sign in to comment.