[GH-ISSUE #15] CommonMark mention #10

Closed
opened 2026-03-03 01:23:00 +03:00 by kerem · 7 comments
Owner

Originally created by @igorshubovych on GitHub (Mar 10, 2016).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/15

Currently README.md call markdownlint A Node.js style checker and lint tool for Markdown files.

Should CommonMark be mentioned too?

As far as I understood it covers CommonMark pretty good. CommonMark nowadays is becoming a de-facto standard, because it has spec unlike Markdown. I see that you included link to this spec in README.md.

Originally created by @igorshubovych on GitHub (Mar 10, 2016). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/15 Currently README.md call markdownlint `A Node.js style checker and lint tool for Markdown files`. Should CommonMark be mentioned too? As far as I understood it covers CommonMark pretty good. CommonMark nowadays is becoming a de-facto standard, because it has spec unlike Markdown. I see that you included link to this spec in README.md.
kerem 2026-03-03 01:23:00 +03:00
Author
Owner

@DavidAnson commented on GitHub (Mar 10, 2016):

Makes sense! As you say, the markdown-it parser is CommonMark-compliant. Because CommonMark is a dialect/subset of Markdown, maybe something like the following:

A Node.js style checker and lint tool for Markdown/CommonMark files.

<!-- gh-comment-id:195091559 --> @DavidAnson commented on GitHub (Mar 10, 2016): Makes sense! As you say, the `markdown-it` parser is CommonMark-compliant. Because CommonMark is a dialect/subset of Markdown, maybe something like the following: > A Node.js style checker and lint tool for Markdown/CommonMark files.
Author
Owner

@igorshubovych commented on GitHub (Mar 10, 2016):

Well, honestly I am not sure. Need to double check.

<!-- gh-comment-id:195102066 --> @igorshubovych commented on GitHub (Mar 10, 2016): Well, honestly I am not sure. Need to double check.
Author
Owner

@igorshubovych commented on GitHub (Mar 10, 2016):

http://talk.commonmark.org/t/is-commonmark-really-markdown-compatible/540

<!-- gh-comment-id:195103949 --> @igorshubovych commented on GitHub (Mar 10, 2016): http://talk.commonmark.org/t/is-commonmark-really-markdown-compatible/540
Author
Owner

@DavidAnson commented on GitHub (Mar 11, 2016):

Lots of strong opinions there. :) My proposal above deliberately does not take sides. "Markdown/CommonMark" suggests that both are supported without saying one is better or a subset, etc..

Until the day we find a rule that needs to behave differently, this may be good enough.

<!-- gh-comment-id:195136502 --> @DavidAnson commented on GitHub (Mar 11, 2016): Lots of strong opinions there. :) My proposal above deliberately does not take sides. "Markdown/CommonMark" suggests that both are supported without saying one is better or a subset, etc.. Until the day we find a rule that needs to behave differently, this may be good enough.
Author
Owner

@DavidAnson commented on GitHub (Mar 11, 2016):

BTW, the title on the page http://commonmark.org/ says the following which is what I based my phrase "dialect/subset" on:

CommonMark - A strongly defined, highly compatible specification of Markdown

<!-- gh-comment-id:195137126 --> @DavidAnson commented on GitHub (Mar 11, 2016): BTW, the title on the page http://commonmark.org/ says the following which is what I based my phrase "dialect/subset" on: > CommonMark - A strongly defined, highly compatible specification of Markdown
Author
Owner

@igorshubovych commented on GitHub (Mar 11, 2016):

CommonMark - A strongly defined, highly compatible specification of Markdown

Then it should be ok to have Markdown/CommonMark

<!-- gh-comment-id:195216011 --> @igorshubovych commented on GitHub (Mar 11, 2016): > CommonMark - A strongly defined, highly compatible specification of Markdown Then it should be ok to have Markdown/CommonMark
Author
Owner

@DavidAnson commented on GitHub (Mar 11, 2016):

Great - I'll make the update soon.

<!-- gh-comment-id:195224872 --> @DavidAnson commented on GitHub (Mar 11, 2016): Great - I'll make the update soon.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/markdownlint#10
No description provided.