Markdown纯后端解析，CommonMark和Flexmark的基本使用

时间：2025-04-09 19:26:01

前言

最近在做个人博客网站 云仔☁笔记，碰到了问题，怎样将Markdown文档解析后显示在页面中，因为前端只会基础，所以想着通过纯后端实现文档解析，通过查询资料我找到了两个办法：

  • 方法一：CommonMark
  • 方法二：Flexmark

以上两个方法，均可以将Markdown文档解析为HTML代码

CommonMark-java

文档阅读：CommonMark-java --GitHub仓库

1. 介绍

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

2. 使用教程

  • 引入Maven依赖
    • commonmark-ext-gfm-tables:用来实现表格的解析的依赖
		<dependency>
            <groupId></groupId>
            <artifactId>commonmark</artifactId>
            <version>0.20.0</version>
        </dependency>
        <!-- 实现表格解析 -->
        <dependency>
            <groupId></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-java

官方文档阅读：Flexmark-java --GitHub仓库

1. 介绍

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

2. 使用示例

  • 引入Maven依赖

    • 最新版本为0.64.8，支持java11及更高，不支持java8
            <dependency>
            <groupId></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);
    }

总结

以上两种方法很好的解决了Markdown文档在后端解析为HTML文档的需求

相关文章