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文档格式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈Java绝对布局

    浅谈Java绝对布局

    这篇文章主要介绍了Java当中的绝对布局,还举了一个简单的实例,需要的朋友可以参考下。
    2017-08-08
  • SpringBoot参数验证的几种方式小结

    SpringBoot参数验证的几种方式小结

    在日常的接口开发中,为了防止非法参数对业务造成影响,经常需要对接口的参数进行校验,例如登录的时候需要校验用户名和密码是否为空,所以本文介绍了SpringBoot参数验证的几种方式,需要的朋友可以参考下
    2024-07-07
  • Java 数组(Array)存储数据的“排排坐”(最新推荐)

    Java 数组(Array)存储数据的“排排坐”(最新推荐)

    这篇文章主要介绍了Java 数组(Array)存储数据的“排排坐”(最新推荐),本文通过实例代码给大家介绍的非常详细,感兴趣的朋友一起看看吧
    2025-05-05
  • java递归实现汉诺塔步骤介绍

    java递归实现汉诺塔步骤介绍

    大家好,本篇文章主要讲的是java递归实现汉诺塔步骤介绍,感兴趣的同学赶快来看一看吧,对你有帮助的话记得收藏一下,方便下次浏览
    2022-01-01
  • spring AMQP代码生成rabbitmq的exchange and queue教程

    spring AMQP代码生成rabbitmq的exchange and queue教程

    使用Spring AMQP代码直接创建RabbitMQ exchange和queue,并确保绑定关系自动成立,简化消息队列配置,此经验分享供参考,欢迎支持脚本之家
    2025-08-08
  • springboot的类加载器(org.springframework.boot.loader)过程详解

    springboot的类加载器(org.springframework.boot.loader)过程详解

    这篇文章主要介绍了springboot的类加载器(org.springframework.boot.loader),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • 全方位解读JDK和JRE的区别及联系

    全方位解读JDK和JRE的区别及联系

    这篇文章主要介绍了JDK和JRE的区别及联系,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • Java System#exit无法退出程序的问题及解决

    Java System#exit无法退出程序的问题及解决

    这篇文章主要介绍了Java System#exit无法退出程序的问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • SpringBoot集成logback打印彩色日志的代码实现

    SpringBoot集成logback打印彩色日志的代码实现

    Logback是由log4j创始人设计的另一个开源日志组件,默认情况下,Spring Boot会用Logback来记录日志,并用INFO级别输出到控制台,本文给大家介绍了SpringBoot集成logback打印彩色日志,需要的朋友可以参考下
    2024-03-03
  • 详解MyBatis增删改查SQL案例实战

    详解MyBatis增删改查SQL案例实战

    本文通过具体的SQL案例,详细介绍了MyBatis的增删改查操作,通过灵活的Mapper接口和XML配置,MyBatis能够实现高效的数据操作,同时支持动态SQL和批量操作,极大地提升了开发效率,感兴趣的可以了解一下
    2026-03-03

最新评论