Skip to content

Render ThematicBreak literal in markdown #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robinst merged 1 commit into from
Sep 12, 2024
Merged

Render ThematicBreak literal in markdown #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions commonmark/src/main/java/org/commonmark/renderer/markdown/CoreMarkdownNodeRenderer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,12 @@ public void visit(Document document) {

@Override
public void visit(ThematicBreak thematicBreak) {
// Let's use ___ as it doesn't introduce ambiguity with * or - list item markers
writer.raw("___");
String literal = thematicBreak.getLiteral();
if (literal == null) {
// Let's use ___ as it doesn't introduce ambiguity with * or - list item markers
literal = "___";
}
writer.raw(literal);
writer.block();
}

Expand Down
8 changes: 8 additions & 0 deletions commonmark/src/test/java/org/commonmark/renderer/markdown/MarkdownRendererTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ public void testThematicBreaks() {
// List item with hr -> hr needs to not use the same as the marker
assertRoundTrip("* ___\n");
assertRoundTrip("- ___\n");

// Preserve the literal
assertRoundTrip("----\n");
assertRoundTrip("*****\n");

// Apply fallback for null literal
ThematicBreak node = new ThematicBreak();
assertEquals("___", render(node));
}

@Test
Expand Down