yogthos/markdown-clj

Apostrophe in URL causes parser to fail to parse automatic links

Open

#156 opened on Sep 16, 2019

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Clojure (120 forks)github user discovery
bughelp wanted

Repository metrics

Stars
 (570 stars)
PR merge metrics
 (PR metrics pending)

Description

The automatic link parser fails if URLs contains an apostrophe.

Plain URL

The automatic link normally takes a URL like this: (md-to-html-string "Test: <https://www.google.com>")

And generates an anchor tag like this: "<p>Test: <a href=\"https://www.google.com\">https://www.google.com</a></p>"

URL with apostrophe

But if the link contains an apostrophe: (md-to-html-string "Test: <https://www.page.com/Bob's-page>")

It gets treated as plain text: "<p>Test: <https://www.page.com/Bob's-page></p>"

Alternative syntax [description](url) works fine

(md-to-html-string "Test: [https://www.page.com/Bob's-page](https://www.page.com/Bob's-page)")

"<p>Test: <a href='https://www.page.com/Bob's-page'>https://www.page.com/Bob's-page</a></p>"

I came across this while pasting some random github wiki page URLs into my app.

Contributor guide

Research direction
Examine the automatic link regex in markdown clj to see why apostrophe is not included as a valid character. Update the regex or parsing logic to allow apostrophes in URLs.
Tech stack
clojure
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Clojure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70