Java Markdown Generator

Simple to use Java library to generate beautiful markdown.

Usage

Integration

Gradle

You can get snapshot and release builds from JitPack:

repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
compile 'com.github.Steppschuh:Java-Markdown-Generator:master-SNAPSHOT'
}

Alternatively, release builds are also available on Bintray:

repositories {
maven { url 'http://dl.bintray.com/steppschuh/Markdown-Generator' }
}
dependencies {
compile 'net.steppschuh.markdowngenerator:markdowngenerator:1.3.2'
}

Maven

<dependency>
<groupId>net.steppschuh.markdowngenerator</groupId>
<artifactId>markdowngenerator</artifactId>
<version>1.3.2</version>
</dependency>

JAR

You can download the latest .jar files from GitHub or Bintray.

Examples

Most Markdown elements have static convenience methods in the Markdown class. You can also use their repesctive constructors, as shown below.

Emphasis

@Testpublicvoidexample() throwsException {
StringBuildersb = newStringBuilder()
.append(newText("I am normal")).append("\n")
.append(newBoldText("I am bold")).append("\n")
.append(newItalicText("I am italic")).append("\n")
.append(newStrikeThroughText("I am strike-through"));
System.out.println(sb);
}

Output:

I am normal
**I am bold**
_I am italic_
~~I am strike-through~~

Headings

@Testpublicvoidexample() throwsException {
StringBuildersb = newStringBuilder()
.append(newHeading("Heading with level 1", 1)).append("\n")
.append(newHeading("Heading with level 2", 2)).append("\n")
.append(newHeading("Heading with level 3", 3)).append("\n")
.append(newHeading("Heading with level 4", 4)).append("\n")
.append(newHeading("Heading with level 5", 5)).append("\n")
.append(newHeading("Heading with level 6", 6));
System.out.println(sb);
}

Output:

Heading with level 1
====================
Heading with level 2
--------------------
### Heading with level 3
#### Heading with level 4
##### Heading with level 5
###### Heading with level 6

Rules

@Testpublicvoidexample() throwsException {
System.out.println(newHorizontalRule());
System.out.println(newHorizontalRule(20, HorizontalRule.ASTERISK));
}

Output:

---
********************

Images

@Testpublicvoidexample() throwsException {
Stringtext = "I am an image";
Stringurl = "https://dummyimage.com/300";
System.out.println(newImage(text, url));
}

Output:

![I am an image](https://dummyimage.com/300)

Lists

@Testpublicvoidexample() throwsException {
List<Object> items = Arrays.asList(
"Items can be anything",
newDate(0),
1337
);
System.out.println(newUnorderedList<>(items));
}

Output:

- Items can be anything
- Thu Jan 01 01:00:00 CET 1970
- 1337

Tasks

@Testpublicvoidexample() throwsException {
List<TaskListItem> items = Arrays.asList(
newTaskListItem("Task 1", true),
newTaskListItem("Task 2", false),
newTaskListItem("Task 3")
);
System.out.println(newTaskList(items));
}

Output:

- [x] Task 1
- [ ] Task 2
- [ ] Task 3

Tables

@Testpublicvoidexample() throwsException {
Table.BuildertableBuilder = newTable.Builder()
.withAlignments(Table.ALIGN_RIGHT, Table.ALIGN_LEFT)
.withRowLimit(7)
.addRow("Index", "Boolean");
for (inti = 1; i <= 20; i++) {
tableBuilder.addRow(i, Math.random() > 0.5);
}
System.out.println(tableBuilder.build());
}

Output:

| Index | Boolean |
| -----:| ------- |
| 1 | false |
| 2 | true |
| 3 | false |
| ~~~~~ | ~~~~~~~ |
| 18 | false |
| 19 | true |
| 20 | false |

Code

@Testpublicvoidexample() throwsException {
Stringcode = "// notice this new line\n" +
"System.out.println(\"Hello\");";
System.out.println(newCodeBlock(code, "Java"));
}

Output:

 ```Java
// notice this new line
System.out.println("Hello");
```