快捷導(dǎo)航

Java 解析Markdown文檔格式的兩種方式

更新時間：2024年10月22日 09:26:02 作者：_江嶼_

CommonMark和Flexmark是兩種用于解析Markdown文檔的Java庫,CommonMark提供了一種簡潔和一致的Markdown格式語法規(guī)范,但不支持目錄解析,而Flexmark是一個基于CommonMark的擴(kuò)展庫,不僅遵循了CommonMark規(guī)范,還提供了更多靈活的API和擴(kuò)展功能

方法一：CommonMark

1. 介紹

CommonMark是一個規(guī)范，定義了一種簡潔、一致的 Markdown 格式語法。它旨在提供一種標(biāo)準(zhǔn)的方式來解析和渲染 Markdown 文檔。

2. 使用教程

引入Maven依賴
commonmark-ext-gfm-tables:用來實現(xiàn)表格的解析的依賴

 <dependency>
            <groupId>org.commonmark</groupId>
            <artifactId>commonmark</artifactId>
            <version>0.20.0</version>
        </dependency>
        <!-- 實現(xiàn)表格解析 -->
        <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. 問題

無法實現(xiàn)目錄的解析，也就是Markdown文檔中的[TOC]，當(dāng)然Flexmark很好的解決了這個問題。

方法二：Flexmark

1. 介紹

Flexmark-Java是一個基于 CommonMark 規(guī)范的 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);
    }

到此這篇關(guān)于Java 解析Markdown文檔格式的文章就介紹到這了,更多相關(guān)Java Markdown文檔格式內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: