Merge pull request #341 from commonmark/release-0.23

Prepare release 0.23
commonmark · Sep 16, 2024 · 15bd59f · 15bd59f
2 parents 0fb7a16 + bc231e2
commit 15bd59f
Show file tree

Hide file tree

Showing 14 changed files with 54 additions and 35 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,25 +6,43 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html),
 with the exception that 0.x versions can break between minor versions.
 
-## Unreleased
+## [0.23.0] - 2024-09-16
 ### Added
-- Support for extending inline parsing with custom inline content parsers! See
-  `Parser.Builder#customInlineContentParserFactory`. This allows users or
-  extensions to hook into inline parsing on a deeper level than using delimiter
-  processors. It could be used to implement support for math/latex formulas for
-  example.
+- New extension for footnotes!
+  - Syntax:
+    ```
+    Main text[^1]
+    
+    [^1]: Additional text in a footnote
+    ```
+  - Inline footnotes like `^[inline footnote]` are also supported when enabled
+    via an option in `FootnotesExtension.Builder`
+  - Use class `FootnotesExtension` in artifact `commonmark-ext-footnotes` (#332)
+- New option `omitSingleParagraphP` in `HtmlRenderer.Builder` for not using `<p>` 
+  tags for when a document only has one paragraph (#150)
+- Support for custom link processing during inline parsing (e.g. `[foo]`),
+  see `Parser.Builder#linkProcessor`
+- Support for extending inline parsing with custom inline content parsers. See
+  `Parser.Builder#customInlineContentParserFactory`. This allows users/extensions
+  to hook into inline parsing on a deeper level than before (e.g. with delimiter
+  processors). It can be used to add support for math/latex formulas or other inline
+  syntax. (#321)
 ### Changed
+- The default `DefaultUrlSanitizer` now also allows `data` as a protocol. Use the
+  constructor with a list to customize this. (#329)
 - `LinkReferenceDefinition` now extends `Block` (it was extending `Node`
   directly before)
+- `MarkdownRenderer`: Don't escape `=` text if it's the first node in a block (#335)
 ### Fixed
-- Fix parsing of link reference definitions where it looks like it has a title
-  but it doesn't because it's followed by characters other than space/tab. In that
-  case, the title was set to the partially-parsed title and the source spans were
-  wrong (#315).
+- Fix parsing of link reference definitions with incorrect title syntax (followed
+  by characters other than space/tab). In that case, the title was set to the
+  partially-parsed title and the source spans were wrong. (#315)
+- Fix source spans of blocks with lazy continuation lines (#337)
+- `MarkdownRenderer`: Preserve thematic break literals (#331)
 
 ## [0.22.0] - 2024-03-15
 ### Added
-- New `MarkdownRenderer` for rendering nodes to Markdown (CommonMark)!
+- New `MarkdownRenderer` for rendering nodes to Markdown (CommonMark) (#306)!
   Note that while care is taken to produce equivalent Markdown, some differences
   in the original Markdown (if parsed) are not preserved, such as:
   - The type of heading used
@@ -397,7 +415,7 @@ API breaking changes (caused by changes in spec):
 - Rename `HorizontalRule` to `ThematicBreak`
 - Rename `HtmlTag` to `HtmlInline`
 - Replace `MatchedBlockParser#getParagraphStartLine` with `#getParagraphContent`
-  that returns the current content if the the matched block is a paragraph
+  that returns the current content if the matched block is a paragraph
 
 ## [0.3.2] - 2016-01-07
 ### Fixed
@@ -427,6 +445,7 @@ API breaking changes (caused by changes in spec):
 Initial release of commonmark-java, a port of commonmark.js with extensions
 for autolinking URLs, GitHub flavored strikethrough and tables.
 
+[0.23.0]: https://github.com/commonmark/commonmark-java/compare/commonmark-parent-0.22.0...commonmark-parent-0.23.0
 [0.22.0]: https://github.com/commonmark/commonmark-java/compare/commonmark-parent-0.21.0...commonmark-parent-0.22.0
 [0.21.0]: https://github.com/commonmark/commonmark-java/compare/commonmark-parent-0.20.0...commonmark-parent-0.21.0
 [0.20.0]: https://github.com/commonmark/commonmark-java/compare/commonmark-parent-0.19.0...commonmark-parent-0.20.0

diff --git a/commonmark-ext-autolink/pom.xml b/commonmark-ext-autolink/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-ext-autolink</artifactId>

diff --git a/commonmark-ext-footnotes/pom.xml b/commonmark-ext-footnotes/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-ext-footnotes</artifactId>

diff --git a/commonmark-ext-gfm-strikethrough/pom.xml b/commonmark-ext-gfm-strikethrough/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-ext-gfm-strikethrough</artifactId>

diff --git a/commonmark-ext-gfm-tables/pom.xml b/commonmark-ext-gfm-tables/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-ext-gfm-tables</artifactId>

diff --git a/commonmark-ext-heading-anchor/pom.xml b/commonmark-ext-heading-anchor/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-ext-heading-anchor</artifactId>

diff --git a/commonmark-ext-image-attributes/pom.xml b/commonmark-ext-image-attributes/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-ext-image-attributes</artifactId>

diff --git a/commonmark-ext-ins/pom.xml b/commonmark-ext-ins/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-ext-ins</artifactId>

diff --git a/commonmark-ext-task-list-items/pom.xml b/commonmark-ext-task-list-items/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-ext-task-list-items</artifactId>

diff --git a/commonmark-ext-yaml-front-matter/pom.xml b/commonmark-ext-yaml-front-matter/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <artifactId>commonmark-parent</artifactId>
         <groupId>org.commonmark</groupId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-ext-yaml-front-matter</artifactId>

diff --git a/commonmark-integration-test/pom.xml b/commonmark-integration-test/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-integration-test</artifactId>

diff --git a/commonmark-test-util/pom.xml b/commonmark-test-util/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark-test-util</artifactId>

diff --git a/commonmark/pom.xml b/commonmark/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.commonmark</groupId>
         <artifactId>commonmark-parent</artifactId>
-        <version>0.22.1-SNAPSHOT</version>
+        <version>0.23.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>commonmark</artifactId>

diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 
     <groupId>org.commonmark</groupId>
     <artifactId>commonmark-parent</artifactId>
-    <version>0.22.1-SNAPSHOT</version>
+    <version>0.23.0-SNAPSHOT</version>
     <name>commonmark-java parent</name>
     <description>
         Java implementation of CommonMark, a specification of the Markdown format for turning plain text into formatted
@@ -112,52 +112,52 @@
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-ext-autolink</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-ext-image-attributes</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-ext-ins</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-ext-gfm-strikethrough</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-ext-gfm-tables</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-ext-heading-anchor</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-ext-task-list-items</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-ext-yaml-front-matter</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-test-util</artifactId>
-                <version>0.22.1-SNAPSHOT</version>
+                <version>0.23.0-SNAPSHOT</version>
             </dependency>
 
             <!-- Common test dependencies -->