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-java/
├── commonmark/
├── commonmark-ext-autolink/
├── commonmark-ext-gfm-strikethrough/
├── commonmark-ext-gfm-tables/
├── commonmark-ext-heading-anchor/
├── commonmark-ext-image-attributes/
├── commonmark-ext-ins/
├── commonmark-ext-task-list-items/
├── commonmark-ext-yaml-front-matter/
├── commonmark-android-test/
├── commonmark-integration-test/
├── commonmark-test-util/
├── etc/
└── ...

目录介绍：

• commonmark/: 核心库，包含基本的 Markdown 解析和渲染功能。
• commonmark-ext-autolink/: 扩展库，支持自动链接功能。
• commonmark-ext-gfm-strikethrough/: 扩展库，支持 GitHub Flavored Markdown 的删除线功能。
• commonmark-ext-gfm-tables/: 扩展库，支持 GitHub Flavored Markdown 的表格功能。
• commonmark-ext-heading-anchor/: 扩展库，支持为标题生成锚点。
• commonmark-ext-image-attributes/: 扩展库，支持为图片添加属性。
• commonmark-ext-ins/: 扩展库，支持插入标记。
• commonmark-ext-task-list-items/: 扩展库，支持任务列表项。
• commonmark-ext-yaml-front-matter/: 扩展库，支持 YAML 前置内容。
• commonmark-android-test/: 针对 Android 平台的测试目录。
• commonmark-integration-test/: 集成测试目录。
• commonmark-test-util/: 测试工具目录。
• etc/: 其他配置和资源文件。

2. 项目的启动文件介绍

CommonMark Java 项目没有特定的启动文件，因为它是一个库，需要集成到其他 Java 项目中使用。通常，开发者会在自己的项目中引入 CommonMark 库，并编写相应的代码来解析和渲染 Markdown 文本。

例如，以下是一个简单的示例代码：

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

public class CommonmarkExample {
    public static void main(String[] args) {
        Parser parser = Parser.builder().build();
        Node document = parser.parse("This is *Sparta*");
        HtmlRenderer renderer = HtmlRenderer.builder().build();
        System.out.println(renderer.render(document));
    }
}

3. 项目的配置文件介绍

CommonMark Java 项目没有特定的配置文件，因为它主要通过代码进行配置。开发者可以根据需要使用不同的扩展库和配置选项。

例如，引入扩展库的 Maven 依赖：

<dependency>
    <groupId>org.commonmark</groupId>
    <artifactId>commonmark-ext-gfm-tables</artifactId>
    <version>0.22.0</version>
</dependency>

在代码中使用扩展库：

import org.commonmark.ext.gfm.tables.TablesExtension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.HtmlRenderer;

import java.util.Arrays;

public class CommonmarkExample {
    public static void main(String[] args) {
        Parser parser = Parser.builder()
                .extensions(Arrays.asList(TablesExtension.create()))
                .build();
        Node document = parser.parse("This is a table:\n\n| Header | Header |\n| ------ | ------ |\n| Cell   | Cell   |");
        HtmlRenderer renderer = HtmlRenderer.builder()
                .extensions(Arrays.asList(TablesExtension.create()))
                .build();
        System.out.println(renderer.render(document));
    }
}

通过这种方式，开发者可以根据需要灵活配置和使用 CommonMark Java 库。

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