Use cases/Research

We are moving our team wiki to a new tool. Compare how Markdown tables, task lists and footnotes are specified in CommonMark and in GitHub Flavored Markdown, so we know what will survive the move. Use the official specs and cite each point.

CommonMark is a small, portable core. It does not include tables, task lists or footnotes1. GitHub Flavored Markdown specifies tables and task lists as extensions, and its spec does not define footnotes either2.

FeatureCommonMarkGitHub Flavored Markdown
TablesNot in the specSpecified, as an extension
Task listsNot in the specSpecified, as an extension
FootnotesNot in the specNot in the spec

What will survive the move

  • Tables written in GFM syntax are portable to tools that implement the GFM spec. A strict CommonMark renderer does not guarantee them12
  • Task lists may render as plain list text on a strict CommonMark renderer12
  • Footnotes are not portable by spec alone. GitHub renders them as a feature of its site, outside the GFM spec2
Read
Both official specs
Cited
Every point
NextHere are our monthly sign-ups. Chart them and tell me what changed, and when.

What will you hand off first?

Start with the task you have been putting off.