yogthos/markdown-clj

HR lines written with consecutive - characters are superseded by empty headings

Open

#190 opened on Jan 3, 2023

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

Repository metrics

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

Description

Using 1.11.4

I would PR but I'm not sure the exact cause.

Behavior

This markup:


***

- - -

---

-----

that presumably should be output as

<hr>
<hr>
<hr>
<hr>

is instead transformed to:

<hr>
<hr>
<h2></h2>
<h2></h2>

I believe because empty-line comes before hr in the list of transformers? The h1? and h2? heading checks, present in empty-line, register true for = and - HRs. Or something else...

Would it be as simple as adding hr to the conditions of empty-line here? Or should checks be rewritten, transformers reordered etc. Thanks!

Contributor guide

Research direction
Investigate the empty line transformer in src/cljc/markdown/transformers.cljc. The issue is that lines with consecutive dashes ( ) are being incorrectly parsed as empty headings instead of horizontal rules. Consider adding a check for HR patterns before the heading check, or reordering the transformers to process HR before empty line. The specific condition at line 46 may need to exclude lines that match horizontal rules.
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
ClojureGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75