commonmark使用方法

最新推荐文章于 2024-08-26 08:01:45 发布

速度但是但

最新推荐文章于 2024-08-26 08:01:45 发布

阅读量4.8k

点赞数 5

分类专栏：个人博客

本文链接：https://blog.csdn.net/qq_45279909/article/details/105568530

版权

个人博客专栏收录该内容

1 篇文章 0 订阅

订阅专栏

本文介绍CommonMark，一种用于将Markdown语法转换为HTML的解析器，具备体积小、速度快、灵活性高和可扩展性强的特点。支持Java 8和Java 9，通过简单的Maven依赖即可实现Markdown到HTML的转换，同时提供了自定义HTML标签和添加表格、删除线等功能。

摘要由CSDN通过智能技术生成

commonmark

commonmark是什么：是一个用来将MarkDawn转化Html的解析器
commonmark有什么特点
- 小：核心没有依赖关系，扩展在单独工件中
- 快：转化效率快
- 灵活：可以自定义Html标签
- 可扩展：可添加表格、删除线等
Java支持
- Java8和Java9

如何使用

添加pom.xml依赖

    <dependency>
            <groupId>com.atlassian.commonmark</groupId>
            <artifactId>commonmark-ext-heading-anchor</artifactId>
            <version>0.13.1</version>
        </dependency>
        <dependency>
            <groupId>com.atlassian.commonmark</groupId>
            <artifactId>commonmark-ext-gfm-tables</artifactId>
            <version>0.13.1</version>
        </dependency>

工具类

    public class MarkdownUtils {

    /**
     * markdown格式转换成HTML格式
     * @param markdown
     * @return
     */
    public static String markdownToHtml(String markdown) {
        Parser parser = Parser.builder().build();
        Node document = parser.parse(markdown);
        HtmlRenderer renderer = HtmlRenderer.builder().build();
        return renderer.render(document);
    }

    /**
     * 增加扩展[标题锚点，表格生成]
     * Markdown转换成HTML
     * @param markdown
     * @return
     */
    public static String markdownToHtmlExtensions(String markdown) {
        //h标题生成id
        Set<Extension> headingAnchorExtensions = Collections.singleton(HeadingAnchorExtension.create());
        //转换table的HTML
        List<Extension> tableExtension = Arrays.asList(TablesExtension.create());
        Parser parser = Parser.builder()
                .extensions(tableExtension)
                .build();
        Node document = parser.parse(markdown);
        HtmlRenderer renderer = HtmlRenderer.builder()
                .extensions(headingAnchorExtensions)
                .extensions(tableExtension)
                .attributeProviderFactory(new AttributeProviderFactory() {
                    public AttributeProvider create(AttributeProviderContext context) {
                        return new CustomAttributeProvider();
                    }
                })
                .build();
        return renderer.render(document);
    }

    /**
     * 处理标签的属性
     */
    static class CustomAttributeProvider implements AttributeProvider {
        @Override
        public void setAttributes(Node node, String tagName, Map<String, String> attributes) {
            //改变a标签的target属性为_blank
            if (node instanceof Link) {
                attributes.put("target", "_blank");
            }
            if (node instanceof TableBlock) {
                attributes.put("class", "ui celled table");
            }
        }
    }
}