commonmark / commonmark-java

Java library for parsing and rendering CommonMark (Markdown)
BSD 2-Clause "Simplified" License
2.31k stars 288 forks source link

Java (OpenJDK) using commonmark-java #342

Open robinst opened 2 months ago

robinst commented 2 months ago

Since this pull request, Java (OpenJDK) has included a copy of commonmark-java:

When they copied the source files, they made a few adjustments too. There's a list here:

// This module is primarily an import from a recent tagged version of
//     https://github.com/commonmark/commonmark-java
//
// The following parts are imported:
//
// * commonmark/src/main/java
// * commonmark/src/main/resources
// * commonmark-ext-gfm-tables/src/main/java
// * commonmark-ext-gfm-tables/src/main/resources
//
// For source and resource files, the following transformations are applied:
//
// * legal headers are added
// * package and import statements are updated
// * characters outside the ASCII range are converted to Unicode escapes
// * @SuppressWarnings("fallthrough") is added to getSetextHeadingLevel
// * the value for ENTITY_PATH is updated with the modified package
// * the file `entities.properties` is renamed to `entities.txt`

Let's make it easier for them next time by adopting some of the changes.

robinst commented 1 month ago

Hi @jonathan-gibbons! I saw that OpenJDK recently included commonmark-java for Markdown parsing in Javadoc:

Just wanted to recommend upgrading to version 0.24.0, with these changes: