开源｜用 Java 实现一个生成 Markdown 文本的工具

公司的 IM 每天有许多机器人推送的消息，我也在使用，这个功能是好的，但是当我们想去发送一些格式优美的消息时，却要费许多功夫，主要来源于字符串拼接，如果要拼接出 Markdown 格式的那就更费力了，另外由拼接带来的是混乱的代码，为了解决这个痛点，我写了一个 Java 代码生成 Markdown 文本的工具，还给它起了一个酷名字。

MdKiller —— Markdown 杀手 🥷。

MdKiller 是一个格式化生成 Markdown 文本的工具，支持常用 Markdown 格式生成，例如引用块、代码块、有无序列表、表格等，内容上支持字体样式（style）和内容的嵌套，适用于 IM 消息 Markdown 排版。

以下为 Github 仓库 介绍页内容。

一、使用

1、引入依赖，由于是单文件，直接把文件拷贝到项目即可使用。

2、使用，示例如下：

@Test
public void test(){
   
    String md=MdKiller.of()
    .title("一个标题")
    .text("文本")
    .ref()
        .text("文本1")
        .text("文本2")
        .ul()
            .text("文本3")
            .text("文本4")
        .endUl()
    .endRef()
    .link("链接","https://elltor.com")
    .build();
    System.out.println(md);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

输出 Markdown 文本：

### 一个标题
文本
> 文本1
> 文本2
> - 文本3
> - 文本4

[链接▸](https://elltor.com)
1
2
3
4
5
6
7
8

P.S. 更多演示可以参考单元测试。

二、特性介绍

• 易用性：易于排版文案、支持主流 Markdown 语法内容，就像用代码写 Markdown。
• 通用性：生成内容通用，工具生成标准 Markdown 格式并保障最大兼容性。
• 扩展性：具备一定扩展性，扩展 API 简单；内容多样，理论上所有输入的文本均支持样式。
• 集成：除 JDK 外无依赖；小巧，单文件约 700+ 行代码；
• 鲁棒性：具备一定容错性，所有接口均经过单元测试，见目录 test/java/com/elltor/md。

三、最佳实践

在 IM 中排版消息是痛苦的，这个工具就是要解决这个问题，通常在 IM 排版消息会遇到下列问题：

1. 在程序中直接拼接很难对 Markdown 进行排版，拼接使人头大，维护更加麻烦。（P.S. 不反对使用模版，但当增加/删除模版中的参数时也是麻烦的）
2. 差的 Markdown 消息特点：文案没有结构、重点不突出、交互差，不能突出主题。

因此，我们改善 IM 消息实际上就是解决上面两个问题。

3.1 链式调用 vs 普通调用

用不同的风格生成 Markdown 文本。

/**
  * 链式调用 vs 普通调用
  */
@Test
public void callByChainShow() {
   
    String md = MdKiller.of()
            .title("标题")
            .text("文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落")
            .ref()
                .text("引用中的普通文本")
                .text("引用中的普通文本-设置颜色", MdKiller.Style.RED)
                .text("引用中的普通文本-加粗", MdKiller.Style.BOLD)
                .text(
1
2
3
4
5
6
7
8
9
10
11
12
13