Skip to content

Move to a commonmark compliant markdown parser #1835

@noraj

Description

@noraj

Description

Move from python-markdown to a commonmark compliant markdown parser.

For python:

https://github.com/commonmark/commonmark-spec/wiki/list-of-commonmark-implementations#python

Why

To have standard and compatible markdown instead of weird behavior that must be fixed by dozens of plugins.

Why is CommonMark needed?

John Gruber’s canonical description of Markdown’s syntax does not specify the syntax unambiguously.

Because there is no unambiguous spec, implementations have diverged considerably over the last 10 years. As a result, users are often surprised to find that a document that renders one way on one system (say, a GitHub wiki) renders differently on another (say, converting to docbook using Pandoc). To make matters worse, because nothing in Markdown counts as a “syntax error,” the divergence often isn’t discovered right away.

There’s no standard test suite for Markdown; MDTest is the closest thing we have. The only way to resolve Markdown ambiguities and inconsistencies is Babelmark, which compares the output of 20+ implementations of Markdown against each other to see if a consensus emerges.

We propose a standard, unambiguous syntax specification for Markdown, along with a suite of comprehensive tests to validate Markdown implementations against this specification. We believe this is necessary, even essential, for the future of Markdown.

About python-markdown

Disclaimer

This core issue may be closed soon as @waylan is a core developer of python-markdown so he will probably accept to move away from it.

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