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 (246 forks)batch import
help wanted

Repository metrics

Stars
 (5,538 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Inspect the markdown to HTML conversion logic to ensure special characters are stripped from anchor IDs according to GitHub's behavior.
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.
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
MarkdownJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70