escape hyphens in links to avoid word-wrap

cpuguy83 · Nov 30, 2022 · e5bd727 · e5bd727
1 parent 8d6b5c5
commit e5bd727
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/md2man/roff.go b/md2man/roff.go
@@ -110,7 +110,9 @@ func (r *roffRenderer) RenderNode(w io.Writer, node *blackfriday.Node, entering
 		}
 	case blackfriday.Link:
 		if !entering {
-			out(w, linkTag+string(node.LinkData.Destination)+linkCloseTag)
+			// Hyphens in a link must be escaped to avoid word-wrap in the rendered man page.
+			escapedLink := strings.ReplaceAll(string(node.LinkData.Destination), "-", "\\-")
+			out(w, linkTag+escapedLink+linkCloseTag)
 		}
 	case blackfriday.Image:
 		// ignore images

diff --git a/md2man/roff_test.go b/md2man/roff_test.go
@@ -336,6 +336,8 @@ func TestLinks(t *testing.T) {
 	var tests = []string{
 		"See [docs](https://docs.docker.com/) for\nmore",
 		".nh\n\n.PP\nSee docs\n\\[la]https://docs.docker.com/\\[ra] for\nmore\n",
+		"See [docs](https://docs-foo.docker.com/) for\nmore",
+		".nh\n\n.PP\nSee docs\n\\[la]https://docs\\-foo.docker.com/\\[ra] for\nmore\n",
 	}
 	doTestsInline(t, tests)
 }