Java 解析Markdown文档格式的两种方式

 更新时间:2024年10月22日 09:26:02   作者:_江屿_  
CommonMark和Flexmark是两种用于解析Markdown文档的Java库,CommonMark提供了一种简洁和一致的Markdown格式语法规范,但不支持目录解析,而Flexmark是一个基于CommonMark的扩展库,不仅遵循了CommonMark规范,还提供了更多灵活的API和扩展功能

方法一:CommonMark

1. 介绍

CommonMark是一个规范,定义了一种简洁、一致的 Markdown 格式语法。它旨在提供一种标准的方式来解析和渲染 Markdown 文档。

2. 使用教程

  • 引入Maven依赖
  • commonmark-ext-gfm-tables:用来实现表格的解析的依赖
 <dependency>
            <groupId>org.commonmark</groupId>
            <artifactId>commonmark</artifactId>
            <version>0.20.0</version>
        </dependency>
        <!-- 实现表格解析 -->
        <dependency>
            <groupId>org.commonmark</groupId>
            <artifactId>commonmark-ext-gfm-tables</artifactId>
            <version>0.20.0</version>
        </dependency>

JAVA代码示例

    public static String parseMarkdownCommonmark(String markdownContent) {
        //解析表格
        List<Extension> extensions = Arrays.asList(TablesExtension.create());
        org.commonmark.parser.Parser parser = org.commonmark.parser.Parser.builder().extensions(extensions).build();
        Node document = parser.parse(markdownContent);
        org.commonmark.renderer.html.HtmlRenderer renderer = org.commonmark.renderer.html.HtmlRenderer.builder().extensions(extensions).build();
        return renderer.render(document);
    }

3. 问题

无法实现目录的解析,也就是Markdown文档中的[TOC],当然Flexmark很好的解决了这个问题。

方法二:Flexmark

1. 介绍

Flexmark-Java是一个基于 CommonMark 规范的 Java 库,用于解析和渲染 Markdown 文档。它提供了一个灵活的、易于使用的 API,可以自定义解析和渲染的行为。

2. 使用示例

  • 引入Maven依赖
  • 最新版本为0.64.8,支持java11及更高,不支持java8
  <dependency>
            <groupId>com.vladsch.flexmark</groupId>
            <artifactId>flexmark-all</artifactId>
            <version>0.62.2</version>
            <scope>compile</scope>
        </dependency>

java代码

public static String parseMarkdownFlexmark(String markdown) {
        MutableDataSet options = new MutableDataSet();
        //TOC目录解析,表格解析
        options.set(Parser.EXTENSIONS, Arrays.asList(TocExtension.create(), TablesExtension.create()));
        Parser parser = Parser.builder(options).build();
        Document document = parser.parse(markdown);
        HtmlRenderer renderer = HtmlRenderer.builder(options).build();
        return renderer.render(document);
    }

到此这篇关于Java 解析Markdown文档格式的文章就介绍到这了,更多相关Java Markdown文档格式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot调整ApplicationContextAware如何实现类加载顺序

    SpringBoot调整ApplicationContextAware如何实现类加载顺序

    SpringBoot调整ApplicationContextAware实现类加载顺序问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-05-05
  • Java的动态分派和静态分派的实现

    Java的动态分派和静态分派的实现

    这篇文章主要介绍了Java的动态分派和静态分派的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-03-03
  • java数据结构与算法之桶排序实现方法详解

    java数据结构与算法之桶排序实现方法详解

    这篇文章主要介绍了java数据结构与算法之桶排序实现方法,结合具体实例形式详细分析了桶排序的概念、原理、实现方法与相关操作技巧,需要的朋友可以参考下
    2017-05-05
  • Java详解HashMap实现原理和源码分析

    Java详解HashMap实现原理和源码分析

    这篇文章主要介绍了Java关于HashMap的实现原理并进行源码分析,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-09-09
  • spring boot项目同时传递参数和文件的多种方式代码演示

    spring boot项目同时传递参数和文件的多种方式代码演示

    这篇文章主要介绍了spring boot项目同时传递参数和文件的多种方式,在开发接口中,遇到了需要同时接收参数和文件的情况,可以有多种方式实现文件+参数的接收,这里基于spring boot 3 + vue 3 + axios,做一个简单的代码演示,需要的朋友可以参考下
    2023-06-06
  • JAVA设计模式之备忘录模式原理与用法详解

    JAVA设计模式之备忘录模式原理与用法详解

    这篇文章主要介绍了JAVA设计模式之备忘录模式,简单说明了备忘录模式的概念、原理并结合实例形式分析了java备忘录模式的具体定义及使用方法,需要的朋友可以参考下
    2017-08-08
  • Java 过滤器实现敏感词汇过滤功能

    Java 过滤器实现敏感词汇过滤功能

    通过使用 Java 过滤器,我们可以轻松地实现敏感词汇过滤的功能,以保护用户免受不良内容的侵害,让我们通过一个简单的示例来演示我们的敏感词汇过滤器是如何工作的,感兴趣的朋友一起看看吧
    2024-01-01
  • Java多线程volatile原理及用法解析

    Java多线程volatile原理及用法解析

    这篇文章主要介绍了Java多线程volatile原理及用法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • Java 梳理总结关于static关键字常见问题

    Java 梳理总结关于static关键字常见问题

    static关键字基本概念我们可以一句话来概括:方便在没有创建对象的情况下来进行调用。也就是说:被static关键字修饰的不需要创建对象去调用,直接根据类名就可以去访问,让我们来了解一下你可能还不知道情况
    2022-04-04
  • Spring-boot的debug调试代码实例

    Spring-boot的debug调试代码实例

    这篇文章主要介绍了Spring-boot的debug调试代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12

最新评论