Feature order in Markdown documentation incorrect and other inconsistencies
In the announcement on the Commonmark Discourse, I said that there were some inconsistencies in the Markdown parser documentation. This contribution improves some of that, but not quite all of it.
- moves (sub)sections into proper places
- adds a distinction for the term GFM where necessary, because the acronym is also used for GitHub Flavored Markdown which is slightly different
- merges three tables in Special GitLab References into a single one, without adding any examples.
Issue created on behalf of @Crissov
From the CommonMark thread
Your documentation needs some cleanup, though, because it puts some features under the Standard Markdown heading that are neither in Commonmark nor in Gruberʼs specification, e.g. strike-through and tables.
It is not really helping that your are using the same acronym, “GFM”, to refer to GitLab Flavored Markdown that everyone else is using for GitHub Flavored Markdown. You should probably also document the differences between the two, e.g.
inline math
, fenced block quotes >>>, videos , diffs ins del .