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构建docker镜像并推送到阿里云

    springboot构建docker镜像并推送到阿里云

    本文主要介绍了springboot构建docker镜像并推送到阿里云,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-05-05
  • 使用springboot logback动态获取application的配置项

    使用springboot logback动态获取application的配置项

    这篇文章主要介绍了使用springboot logback动态获取application的配置项,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Spring Boot+maven打war包的方法

    Spring Boot+maven打war包的方法

    这篇文章主要介绍了Spring Boot+maven打war包的方法,本文通过实例代码相结合的形式给大家介绍的非常详细,需要的朋友参考下吧
    2018-05-05
  • 使用@pathvariable与@requestparam碰到的一些问题及解决

    使用@pathvariable与@requestparam碰到的一些问题及解决

    这篇文章主要介绍了使用@pathvariable与@requestparam碰到的一些问题及解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Java网络编程UDP实现多线程在线聊天

    Java网络编程UDP实现多线程在线聊天

    这篇文章主要为大家详细介绍了Java网络编程UDP实现多线程在线聊天,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-07-07
  • feign实现传递参数的三种方式小结

    feign实现传递参数的三种方式小结

    这篇文章主要介绍了feign实现传递参数的三种方式小结,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • iReport使用教程(示例教程)

    iReport使用教程(示例教程)

    在使用ireport的过程中,因为各种功能都要百度,但是大家使用的例子又千差万别让人很苦恼,所以用一个简单例子贯穿的展示一下ireport的常见功能
    2021-10-10
  • Spring MVC拦截器和跨域请求使用详解

    Spring MVC拦截器和跨域请求使用详解

    SpringMVC的拦截器也是AOP思想的一种实现方式,主要用于拦截用户的请求并做相应的处理,通常应用在权限验证、记录请求信息的日志、判断用户是否登录等功能上,这篇文章主要介绍了Spring MVC拦截器和跨域请求,需要的朋友可以参考下
    2023-07-07
  • java Executors工具类的相关方法使用创建

    java Executors工具类的相关方法使用创建

    这篇文章主要为大家介绍了java Executors工具类的相关方法使用创建,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-11-11
  • 一文详解Elasticsearch和MySQL之间的数据同步问题

    一文详解Elasticsearch和MySQL之间的数据同步问题

    Elasticsearch中的数据是来自于Mysql数据库的,因此当数据库中的数据进行增删改后,Elasticsearch中的数据,索引也必须跟着做出改变。本文主要来和大家探讨一下Elasticsearch和MySQL之间的数据同步问题,感兴趣的可以了解一下
    2023-04-04

最新评论