Prepare to release 2.0.0 stable

thephpleague · Jul 24, 2021 · 167142b · 167142b
1 parent 61f4efe
commit 167142b
Show file tree

Hide file tree

Showing 73 changed files with 56 additions and 47 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi
 
 ## [Unreleased][unreleased]
 
+## [2.0.0] - 2021-07-24
+
+No changes were introduced since the previous RC2 release.
+See all entries below for a list of changes between 1.x and 2.0.
+
 ## [2.0.0-rc2] - 2021-07-17
 
 ### Fixed
@@ -327,7 +332,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.0.0-rc2...main
+[unreleased]: https://github.com/thephpleague/commonmark/compare/2.0.0...main
+[2.0.0]: https://github.com/thephpleague/commonmark/compare/2.0.0-rc2...2.0.0
 [2.0.0-rc2]: https://github.com/thephpleague/commonmark/compare/2.0.0-rc1...2.0.0-rc2
 [2.0.0-rc1]: https://github.com/thephpleague/commonmark/compare/2.0.0-beta3...2.0.0-rc1
 [2.0.0-beta3]: https://github.com/thephpleague/commonmark/compare/2.0.0-beta2...2.0.0-beta3

diff --git a/README.md b/README.md
@@ -119,9 +119,9 @@ Any classes or methods marked `@internal` are not intended for use outside of th
 
 ## 🛠️ Maintenance & Support
 
-When a new **minor** version (e.g. `1.4` -> `1.5`) is released, the previous one (`1.4`) will continue to receive security and critical bug fixes for *at least* 3 months.
+When a new **minor** version (e.g. `1.5` -> `1.6`) is released, the previous one (`1.5`) will continue to receive security and critical bug fixes for *at least* 3 months.
 
-When a new **major** version is released (e.g. `1.5` -> `2.0`), the previous one (`1.5`) will receive critical bug fixes for *at least* 3 months and security updates for 6 months after that new release comes out.
+When a new **major** version is released (e.g. `1.6` -> `2.0`), the previous one (`1.6`) will receive critical bug fixes for *at least* 3 months and security updates for 6 months after that new release comes out.
 
 (This policy may change in the future and exceptions may be made on a case-by-case basis.)
 

diff --git a/RELEASE_CHECKLIST.md b/RELEASE_CHECKLIST.md
@@ -5,7 +5,7 @@
  - [ ] Ensure all tests are passing (check GitHub workflows).
  - [ ] Ensure changes are documented in `CHANGELOG.md`. Release titles should be linked to GitHub.
  - [ ] If breaking changes or deprecations are introduced, document the upgrade process in the doc site's upgrade page.
- - [ ] Bump the `branch-alias` in `composer.json` and the dev `VERSION` in `CommonMarkConverter` if needed.
+ - [ ] Bump the `branch-alias` in `composer.json` if needed.
  - [ ] Ensure all changes above make it into the `main` branch
 
 ## Documentation

diff --git a/docs/1.6/basic-usage.md b/docs/1.6/basic-usage.md
@@ -2,7 +2,6 @@
 layout: default
 title: Basic Usage
 description: Basic usage of the CommonMark parser
-redirect_from: /basic-usage/
 ---
 
 # Basic Usage

diff --git a/docs/1.6/changelog.md b/docs/1.6/changelog.md
@@ -2,7 +2,6 @@
 layout: default
 title: Changelog
 description: Important changes made in recent releases
-redirect_from: /changelog/
 ---
 
 # Changelog

diff --git a/docs/1.6/configuration.md b/docs/1.6/configuration.md
@@ -1,7 +1,6 @@
 ---
 layout: default
 title: Configuration
-redirect_from: /configuration/
 ---
 
 # Configuration

diff --git a/docs/1.6/customization/abstract-syntax-tree.md b/docs/1.6/customization/abstract-syntax-tree.md
@@ -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

diff --git a/docs/1.6/customization/block-parsing.md b/docs/1.6/customization/block-parsing.md
@@ -2,7 +2,6 @@
 layout: default
 title: Block Parsing
 description: How to parse block-level elements
-redirect_from: /customization/block-parsing/
 ---
 
 # Block Parsing

diff --git a/docs/1.6/customization/block-rendering.md b/docs/1.6/customization/block-rendering.md
@@ -2,7 +2,6 @@
 layout: default
 title: Block Rendering
 description: How to customize the rendering of block-level elements
-redirect_from: /customization/block-rendering/
 ---
 
 # Block Rendering

diff --git a/docs/1.6/customization/cursor.md b/docs/1.6/customization/cursor.md
@@ -2,7 +2,6 @@
 layout: default
 title: Cursor
 description: Using the Cursor object to parse Markdown content
-redirect_from: /customization/cursor/
 ---
 
 # Cursor

diff --git a/docs/1.6/customization/delimiter-processing.md b/docs/1.6/customization/delimiter-processing.md
@@ -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

diff --git a/docs/1.6/customization/environment.md b/docs/1.6/customization/environment.md
@@ -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

diff --git a/docs/1.6/customization/event-dispatcher.md b/docs/1.6/customization/event-dispatcher.md
@@ -2,8 +2,6 @@
 layout: default
 title: Event Dispatcher
 description: How to leverage the event dispatcher to hook into the library
-redirect_from:
-- /customization/document-processing/
 ---
 
 # Event Dispatcher

diff --git a/docs/1.6/customization/extensions.md b/docs/1.6/customization/extensions.md
@@ -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

diff --git a/docs/1.6/customization/inline-parsing.md b/docs/1.6/customization/inline-parsing.md
@@ -2,7 +2,6 @@
 layout: default
 title: Inline Parsing
 description: Parsing inline elements with a custom parser
-redirect_from: /customization/inline-parsing/
 ---
 
 # Inline Parsing

diff --git a/docs/1.6/customization/inline-rendering.md b/docs/1.6/customization/inline-rendering.md
@@ -2,7 +2,6 @@
 layout: default
 title: Inline Rendering
 description: Customizing the output when rendering inline elements
-redirect_from: /customization/inline-rendering/
 ---
 
 # Inline Rendering

diff --git a/docs/1.6/customization/overview.md b/docs/1.6/customization/overview.md
@@ -2,9 +2,6 @@
 layout: default
 title: Customization Overview
 description: An overview of the powerful customization features
-redirect_from:
-- /customization/
-- /customization/overview/
 ---
 
 # Customization Overview

diff --git a/docs/1.6/extensions/attributes.md b/docs/1.6/extensions/attributes.md
@@ -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

diff --git a/docs/1.6/extensions/autolinks.md b/docs/1.6/extensions/autolinks.md
@@ -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

diff --git a/docs/1.6/extensions/commonmark.md b/docs/1.6/extensions/commonmark.md
@@ -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

diff --git a/docs/1.6/extensions/disallowed-raw-html.md b/docs/1.6/extensions/disallowed-raw-html.md
@@ -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

diff --git a/docs/1.6/extensions/external-links.md b/docs/1.6/extensions/external-links.md
@@ -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

diff --git a/docs/1.6/extensions/footnotes.md b/docs/1.6/extensions/footnotes.md
@@ -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

diff --git a/docs/1.6/extensions/github-flavored-markdown.md b/docs/1.6/extensions/github-flavored-markdown.md
@@ -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

diff --git a/docs/1.6/extensions/heading-permalinks.md b/docs/1.6/extensions/heading-permalinks.md
@@ -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

diff --git a/docs/1.6/extensions/inlines-only.md b/docs/1.6/extensions/inlines-only.md
@@ -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

diff --git a/docs/1.6/extensions/mentions.md b/docs/1.6/extensions/mentions.md
@@ -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

diff --git a/docs/1.6/extensions/overview.md b/docs/1.6/extensions/overview.md
@@ -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

diff --git a/docs/1.6/extensions/smart-punctuation.md b/docs/1.6/extensions/smart-punctuation.md
@@ -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

diff --git a/docs/1.6/extensions/strikethrough.md b/docs/1.6/extensions/strikethrough.md
@@ -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

diff --git a/docs/1.6/extensions/table-of-contents.md b/docs/1.6/extensions/table-of-contents.md
@@ -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

diff --git a/docs/1.6/extensions/tables.md b/docs/1.6/extensions/tables.md
@@ -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

diff --git a/docs/1.6/extensions/task-lists.md b/docs/1.6/extensions/task-lists.md
@@ -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

diff --git a/docs/1.6/installation.md b/docs/1.6/installation.md
@@ -2,7 +2,6 @@
 layout: default
 title: Installation
 description: Instructions on how to install the league/commonmark library
-redirect_from: /installation/
 ---
 
 # Installation

diff --git a/docs/1.6/security.md b/docs/1.6/security.md
@@ -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

diff --git a/docs/1.6/support.md b/docs/1.6/support.md
@@ -2,7 +2,6 @@
 layout: default
 title: Support
 description: Get help with the league/commonmark library
-redirect_from: /support/
 ---
 
 # Support

diff --git a/docs/1.6/upgrading.md b/docs/1.6/upgrading.md
@@ -2,7 +2,6 @@
 layout: default
 title: Upgrading from 1.5 - 1.6
 description: Guide to upgrading to newer versions of this library
-redirect_from: /upgrading/
 ---
 
 # Upgrading from 1.5 to 1.6

diff --git a/docs/2.0/basic-usage.md b/docs/2.0/basic-usage.md
@@ -2,6 +2,7 @@
 layout: default
 title: Basic Usage
 description: Basic usage of the CommonMark parser
+redirect_from: /basic-usage/
 ---
 
 # Basic Usage

diff --git a/docs/2.0/changelog.md b/docs/2.0/changelog.md
@@ -2,6 +2,7 @@
 layout: default
 title: Changelog
 description: Important changes made in recent releases
+redirect_from: /changelog/
 ---
 
 # Changelog

diff --git a/docs/2.0/configuration.md b/docs/2.0/configuration.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Configuration
+redirect_from: /configuration/
 ---
 
 # Configuration

diff --git a/docs/2.0/customization/abstract-syntax-tree.md b/docs/2.0/customization/abstract-syntax-tree.md
@@ -2,6 +2,7 @@
 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

diff --git a/docs/2.0/customization/block-parsing.md b/docs/2.0/customization/block-parsing.md
@@ -2,6 +2,7 @@
 layout: default
 title: Block Parsing
 description: How to parse block-level elements
+redirect_from: /customization/block-parsing/
 ---
 
 # Block Parsing

diff --git a/docs/2.0/customization/configuration.md b/docs/2.0/customization/configuration.md
@@ -2,6 +2,7 @@
 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

diff --git a/docs/2.0/customization/cursor.md b/docs/2.0/customization/cursor.md
@@ -2,6 +2,7 @@
 layout: default
 title: Cursor
 description: Using the Cursor object to parse Markdown content
+redirect_from: /customization/cursor/
 ---
 
 # Cursor

diff --git a/docs/2.0/customization/delimiter-processing.md b/docs/2.0/customization/delimiter-processing.md
@@ -2,6 +2,7 @@
 layout: default
 title: Delimiter Processing
 description: Processing CommonMark delimiter runs with a custom processor
+redirect_from: /customization/delimiter-processing/
 ---
 
 # Delimiter Processing

diff --git a/docs/2.0/customization/environment.md b/docs/2.0/customization/environment.md
@@ -2,6 +2,7 @@
 layout: default
 title: The Environment
 description: Configuring the CommonMark environment with custom options and added functionality
+redirect_from: /customization/environment/
 ---
 
 # The Environment