Markdown转换HTML
·
背景
将Markdown文档转换为html,主要是web应用中有些场景会用到,如博客系统,支持Markdown语法的评论功能、代码高亮等等...
要自己去实现这个功能,并没有那么简单,当然面向GitHub编程,就简单很多了
实现
1、markdown 转 html
在github上相关的开源包还是比较多的,这里选择了commonmark
官网:https://github.com/commonmark/commonmark-java
导入pom依赖,(这里我是在maven上导入最新版本,大家可以导入自己喜欢的版本)
<!--引入Markdown转HTML的插件-->
<dependency>
<groupId>com.atlassian.commonmark</groupId>
<artifactId>commonmark</artifactId>
<version>0.17.0</version>
</dependency>
<!--扩展 标题-->
<dependency>
<groupId>com.atlassian.commonmark</groupId>
<artifactId>commonmark-ext-heading-anchor</artifactId>
<version>0.17.0</version>
</dependency>
<!--扩展 表格-->
<dependency>
<groupId>com.atlassian.commonmark</groupId>
<artifactId>commonmark-ext-gfm-tables</artifactId>
<version>0.17.0</version>
</dependency>
如果仅仅是普通的html代码使用,导入第一种即可
3、工具类
package com.k.utils;
import org.commonmark.Extension;
import org.commonmark.ext.gfm.tables.TableBlock;
import org.commonmark.ext.gfm.tables.TablesExtension;
import org.commonmark.ext.heading.anchor.HeadingAnchorExtension;
import org.commonmark.node.Link;
import org.commonmark.node.Node;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.AttributeProvider;
import org.commonmark.renderer.html.AttributeProviderContext;
import org.commonmark.renderer.html.AttributeProviderFactory;
import org.commonmark.renderer.html.HtmlRenderer;
import java.util.*;
/**
* @author k
* @date 2021/10/17 14:07
* @email 3511896104@qq.com
*/
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());
List<Extension> tableExtension = Collections.singletonList(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");
}
}
}
public static void main(String[] args) {
String table = "| hello | hi | k |\n" +
"| ----- | ---- | ----- |\n" +
"| 阿尔及发 | 士大夫 | aa |\n" +
"| 阿什顿发 | 阿斯蒂芬 | 阿斯顿马丁 |\n" +
"\n";
String temp = "[imCoding k](https://blog.csdn.net/jahdgja?spm=1000.2115.3001.5343)";
System.out.println(markdownToHtmlExtensions(table));
}
}
同样如果是普通的html代码使用第一个方法即可
更多推荐
已为社区贡献1条内容
所有评论(0)