element-hq / element-hq/element-meta

Should we go back to GFM rather than CommonMark? (The general Markdown bug)

Open
#330 20 comments 86 reactions 0 assignees View on GitHub
A-Composer O-Frequent S-Minor T-Enhancement X-Needs-Product
Dominant language
No language data
Stars
112
Forks
25
Avg merge
6h 6m
Merged PRs (30d)
4

Description

One fix to the irritating bug https://github.com/vector-im/riot-web/issues/4674 is to go back to GFM from CommonMark. This bug exists to track the comparison i'm building up between them:

https://docs.google.com/spreadsheets/d/1pXWhED9CPtQTnQ5QGrCFSXuSi1yyHV9Gd-dNFIUVXIs/edit#gid=0

It follows on from the conversation at https://github.com/vector-im/riot-web/issues/4809#issuecomment-355158896

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the linked Riot Web issues 4674 and 4809, then review the GFM/CommonMark comparison in the linked Google Sheet. The issue does not name a file or test; done would require reaching a supported decision about whether switching back to GFM resolves the tracked Markdown behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.