Automattic/jetpack

Markdown block: Parsing issues and inconsistencies

Open

#11,881 opened on Oct 12, 2018

View on GitHubContributor guide
 (10 comments) (4 reactions) (0 assignees)PHP (877 forks)user submission
BugEpicGood For CommunityHacktoberfest[Feature] Markdown[Focus] Blocks[Pri] Low

Repository metrics

Stars
 (1,808 stars)
PR merge metrics
 (Avg merge 4d 5h) (645 merged PRs in 30d)

Description

In testing how elements are recognized and parsed in our Jetpack Markdown block for Gutenberg, we've discovered several issues and inconsistencies so far.

This is a master issue for all of them, feel free to add any others that you find.

  • Footnotes / reference links differences -- #30149
  • Images with alts and titles not supported
    • Reported by @jeherve in p1HpG7-5EW-p2 #comment-27928
  • Single empty lines are omitted
    • Reported by @Stojdza in p1HpG7-5EW-p2 #comment-27911
    • Reported by @carladoria in p58i-7sR-p2 #comment-40539
    • Reported by @reginabally in p58i-7sR-p2 #comment-40610
  • Alternative heading syntax parsed incorrectly on iPad Pro
    • Reported by @eliorivero in p1HpG7-5EW-p2 #comment-27968
  • Code block not properly styled
    • Reported by @carladoria in p58i-7sR-p2 #comment-40539

Contributor guide

Research direction
Investigate the Jetpack Markdown block parsing code, focusing on the reported inconsistencies: footnotes, images with alt/title, single empty lines omitted, alternative heading syntax, and code block styling. Trace the markdown to HTML conversion path and test with specific inputs.
Tech stack
phpjavascript
Domain
backend
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.
3-5 days
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
WordPressMarkdownGutenberg
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60