Commonmark-java 使用指南

Commonmark-java 使用指南

commonmark-javaJava library for parsing and rendering CommonMark (Markdown)项目地址:https://gitcode.com/gh_mirrors/co/commonmark-java

1. 项目介绍

Commonmark-java 是一个用于解析和渲染符合(CommonMark)1规范的Markdown文本的Java库。它提供了高性能、灵活性以及扩展性，允许你自定义HTML渲染并操纵抽象语法树(AST)。此外，该项目支持在Java 11及更高版本上运行，同时也适用于Android开发（尽管对Android的支持是尽力而为的）。

2. 项目快速启动

Maven依赖

在你的pom.xml文件中添加以下依赖来引入commonmark-java库：

<dependency>
    <groupId>org.commonmark</groupId>
    <artifactId>commonmark</artifactId>
    <version>0.22.0</version>
</dependency>

示例代码

下面是一个简单的Java程序，演示如何使用commonmark-java解析Markdown并转换成HTML：

import org.commonmark.node.Node;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.HtmlRenderer;

public class CommonmarkQuickStart {
    public static void main(String[] args) {
        // 创建Parser实例
        Parser parser = Parser.builder().build();
        
        // 解析Markdown字符串
        String markdownInput = "# 标题\n这是一段Markdown文本。\n";
        Node document = parser.parse(markdownInput);
        
        // 创建HtmlRenderer实例
        HtmlRenderer renderer = HtmlRenderer.builder().build();
        
        // 渲染成HTML
        String htmlOutput = renderer.render(document);
        
        System.out.println(htmlOutput);  // 输出转换后的HTML
    }
}

执行上述代码，你将会看到Markdown被正确地转化为HTML。

3. 应用案例和最佳实践

• AST操作：解析Markdown后，你可以遍历AST并修改节点以实现自定义的行为，例如添加额外的标签或属性。
• 扩展插件：利用库提供的扩展机制，可以添加如表格、自动链接等特性。
• 安全性：确保渲染Markdown时，防止任意的HTML注入，可以过滤掉不安全的标签或属性。

4. 典型生态项目

• commonmark-extension-autolink：自动链接扩展，将URL转换为可点击的链接。
• commonmark-extension-gfm-strikethrough：GitHub风格的删除线（strikethrough）支持。
• commonmark-extension-gfm-tables：GitHub风格的表格支持。

这些扩展项目可以帮助你构建更丰富的Markdown解析和渲染功能。

通过以上内容，你应该对commonmark-java有了初步的理解，接下来可以尝试使用它来处理实际的Markdown文本，并结合各种扩展来满足你的需求。

commonmark-javaJava library for parsing and rendering CommonMark (Markdown)项目地址:https://gitcode.com/gh_mirrors/co/commonmark-java