Question 1

How do I test my Markdown parser against CommonMark?

Accepted Answer

Use the provided test suite by running `python3 test/spec_tests.py --program $PROG` or install the npm package `commonmark-spec` for JavaScript. This validates conformance with over 500 embedded examples from the spec.

Question 2

What's the difference between CommonMark and GitHub Flavored Markdown?

Accepted Answer

CommonMark is a formal spec focusing on core Markdown syntax, while GitHub Flavored Markdown (GFM) extends it with features like tables and task lists. GFM is based on CommonMark but adds GitHub-specific extensions for richer content.

Question 3

Is CommonMark backward compatible with original Markdown?

Accepted Answer

Yes, it's designed to render most existing Markdown documents as intended, with only a few documented differences like allowing all punctuation to be escaped and adding backslash line breaks to improve predictability.

Question 4

How can I implement CommonMark in my project?

Accepted Answer

Start by using one of the reference implementations in C or JavaScript, or choose from third-party libraries in various languages listed on the wiki. Integrate the parser and test against the spec suite for compliance.

Question 5

Can I extend CommonMark with my own syntax?

Accepted Answer

While possible, extending CommonMark may break spec compliance. The project focuses on core stability first, so custom extensions should be handled carefully, often requiring forking or a layered approach outside the spec.

Question 6

CommonMark or Pandoc for document conversion?

Accepted Answer

CommonMark is a spec for Markdown syntax, ensuring predictable parsing, while Pandoc is a tool that supports multiple formats including CommonMark. Use CommonMark for standardization; use Pandoc for flexible conversion between various markup formats.

CommonMark

What is CommonMark?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions