Skip to content

GitHub Flavored Markdown Specification does include footnote link syntax #270

@ectotropic

Description

@ectotropic

Not sure if this is the correct location for this issue as it concerns https://github.github.com/gfm/ rather than the implementation here, however I can't find a better place for it.

There are some omissions in the official specification for "GitHub Flavored Markdown" for syntax that is supported and mentioned elsewhere on GitHub.

In this case, footnote syntax is supported and referenced in Basic writing and formatting syntax#Footnotes, but is not part of the official specification.

At the very least this means:

  • supporting GitHub Flavored Markdown becomes difficult for implementers (who have to dig into the source or search out other documentation to fully cover what is supported)
  • using GitHub Flavored Markdown becomes difficult for users (who don't know what is actually supported and how the Markdown will be interpreted by any given tool that claims gfm support)

If this is intentional, then this should be stated somewhere in both the specification and the readme, if it is not, the specification needs updated.

See also #220 for more specification omissions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions