developit/snarkdown

Usage of dangling ] messes up the parser.

Open

#12 opened on Mar 13, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (2,157 stars) (129 forks)batch import
bughelp wanted

Description

STR:

  • Use ]] in your string.
  • Observe the markdown output.

Expected:

  • ]] should come up normally.

Actual:

  • ]] doesn't come up.

Demo. Compare it with remarkable

Why I care ?

A Punjabi font uses roman characters to form Punjabi alphabets. It uses ]] for what is know as full stop in Punjabi. It is broken now after I moved from remarkable to snarkdown. I love the perf and size of library, and I understand why this might not be considered to be fixed, but I thought it's worth the shot!

Contributor guide

Tech stack
javascript
Domain
tooling
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptRegular expressions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the snarkdown parser source code (likely index.js) to understand how markdown links and images are parsed, specifically how the regex handles closing brackets. Identify the pattern that matches `[text](url)` or `![alt](url)` and ensure it does not break on literal `]]` in the text. Look for any escaping mechanism or edge case handling. The fix may involve adjusting the regex to allow literal `]]` inside text (e.g., using a negative lookahead or requiring the opening bracket to be preceded by a non escape character). Test the fix against the provided jsfiddle demo.