Welcome to this easy-to-follow guide for flexmark-java, the powerful Java implementation of the CommonMark (spec 0.28) parser. Whether you are a beginner or an experienced developer, this article will help you understand how to leverage the power of flexmark-java in your projects.

What is flexmark-java?

flexmark-java is designed for speed, flexibility, and extensibility when parsing Markdown. It utilizes a blocks-first, inlines-after architecture, allowing you to control parsing options and generate detailed abstracts. Its goal is to effectively mimic other Markdown parsers with high accuracy.

Getting Started with flexmark-java

To kick off your journey with flexmark-java, you need to set it up in your project. Below are the necessary steps:

1. Setup Requirements

• Java Version: For versions 0.62.2 and below, Java 8 or above; For versions 0.64.0 and above, Java 11 or above.
• Maven Dependency: To include flexmark-java in your Maven project, add the following dependency:

    com.vladsch.flexmark
    flexmark-all
    0.64.8

2. Sample Code to Parse Markdown

Below is a simple Java code snippet that demonstrates how to parse Markdown and render it as HTML:

package com.vladsch.flexmark.samples;

import com.vladsch.flexmark.util.ast.Node;
import com.vladsch.flexmark.html.HtmlRenderer;
import com.vladsch.flexmark.parser.Parser;
import com.vladsch.flexmark.util.data.MutableDataSet;

import java.util.Arrays;

public class BasicSample {
    public static void main(String[] args) {
        MutableDataSet options = new MutableDataSet();

        // Set optional extensions
        options.set(Parser.EXTENSIONS, Arrays.asList(
                TablesExtension.create(), 
                StrikethroughExtension.create()));

        // Convert soft-breaks to hard breaks
        options.set(HtmlRenderer.SOFT_BREAK, "
");
        
        Parser parser = Parser.builder(options).build();
        HtmlRenderer renderer = HtmlRenderer.builder(options).build();

        // Parse Markdown text
        Node document = parser.parse("This is *Sparta*");
        String html = renderer.render(document);
        
        System.out.println(html);
    }
}

Understanding the Code Through Analogy

Think of the `` block above as a recipe for a delicious dish you wish to serve at a gathering. Here's how it breaks down: