iamcco/markdown-preview.nvim

Anchor links containing special characters not being stripped

Open

#191 opened on May 15, 2020

View on GitHub
 (1 comment) (2 reactions) (0 assignees)JavaScript (5,538 stars) (246 forks)batch import
help wanted

Description

When I define a section containing special characters, for example:

## api/path/to/resource/<resource_id>/

The preview doesn't strip the slashes and <>, so the anchor link becomes:

#api%2Fpath%2Fto%2Fresource%2F<resource_id>%2F

But on GitHub the actual anchor link would be:

#apipathtoresourceresource_id

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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
JavaScript string methodsHTML anchor tags
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is about anchor links not stripping special characters like slashes and angle brackets. Likely the heading to anchor conversion function in the markdown preview plugin does not filter out non alphanumeric characters. Look for a function that generates anchor IDs from headings, possibly in a JavaScript file handling markdown rendering. Compare with GitHub's anchor generation algorithm which removes all characters except letters, digits, hyphens, and underscores. The fix should replace or sanitize the string to match that behavior.