rtfeldman/elm-css

Media Query documentation should not use `@` symbols in links

Open

#397 opened on Apr 5, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Elm (198 forks)github user discovery
bughelp wanted

Repository metrics

Stars
 (1,259 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi there,

The rendered documentation page for Media.elm has a couple of links to MDN's @media documentation pages, and due to the @ symbol appearing in these URLs, the Markdown parser seems to be turning them into mailto links instead of normal web links.

One specific case can be found here: http://package.elm-lang.org/packages/rtfeldman/elm-css/13.1.1/Css-Media#MediaType

The link it references https://developer.mozilla.org/en-US/docs/Web/CSS/@media#Media_types becomes mailto:https://developer.mozilla.org/en-US/docs/Web/CSS/@media#Media_types

Not sure if this should be a bug filed with elm-markdown or not, but I thought I'd start here.

Contributor guide

Research direction
Escape the @ symbol in the URL or use a different syntax to prevent Markdown from converting it to a mailto link.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90