Question 1

How do I add custom CSS classes to images in commonmark-java?

Accepted Answer

Use an AttributeProviderFactory on the HtmlRenderer builder to set attributes. For example, implement a class that checks for Image nodes and adds a 'class' attribute with your desired value, as shown in the README's attribute provider example.

Question 2

Does commonmark-java support GitHub Flavored Markdown tables?

Accepted Answer

Yes, via the commonmark-ext-gfm-tables extension. Add the dependency and include TablesExtension.create() in the parser and renderer builders to enable table parsing and rendering.

Question 3

What's the difference between commonmark-java and flexmark-java?

Accepted Answer

commonmark-java focuses on strict CommonMark compliance with core extensions, while flexmark-java is a fork that adds many more syntax features and flexibility. Choose commonmark-java for speed and spec adherence, but flexmark-java if you need broader Markdown variant support.

Question 4

Is commonmark-java thread-safe for web applications?

Accepted Answer

Yes, the parser and renderer are designed to be thread-safe after configuration. You can build them once and reuse instances across multiple threads, as stated in the README's thread-safety section.

Question 5

How to parse Markdown with footnotes in commonmark-java?

Accepted Answer

Use the commonmark-ext-footnotes extension. Add the dependency, include FootnotesExtension.create() in the builders, and your Markdown with footnotes will be parsed and rendered correctly, including inline footnotes if enabled.

Question 6

What Java version do I need for commonmark-java?

Accepted Answer

It requires Java 11 or later. The library is optimized for modern Java environments and may not work on older versions, as specified in the README.

commonmark-java

What is commonmark-java?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions