yogthos/markdown-clj

Incorrect rendering of double hyphen within backqotes

Open

#146 opened on Jan 10, 2019

View on GitHub
 (13 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

Everything within backquotes should be rendered literally, but it seems that markdown-clj is converting -- to a single en-dash.

Here's a line that fails:

* `./build-rxl-version.sh --release <release-name>` - Use release from
  `/acme/products/releases/rxl-je/Release/`.

Contributor guide

Research direction
Examine the markdown parsing code to find where double hyphens are converted to en dash and add a check to skip conversion inside backticks.
Tech stack
clojure
Domain
backendtooling
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
ClojureGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
72