Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Homepage/docs is misleading about CommonMark/GFM "support" #1718

Closed
vassudanagunta opened this issue Jul 2, 2020 · 1 comment · Fixed by #1720
Closed

Homepage/docs is misleading about CommonMark/GFM "support" #1718

vassudanagunta opened this issue Jul 2, 2020 · 1 comment · Fixed by #1720
Labels
category: docs Documentation changes

Comments

@vassudanagunta
Copy link
Contributor

Describe the bug
The Marked Homepage/README needs to clarify what it means when it says it "We actively support the features of" CommonMark and GitHub Flavored Markdown.

No where does it mention that Marked is not in full compliance with either spec, that it is in fact a work in progress.

In case the latter point is in dispute, here are some examples:

To Reproduce
Steps to reproduce the behavior:

Two of the above issues already include reproduction steps. But here's another:

  1. Marked Demo
  2. CommonMark Demo

Expected behavior

One of the following:

  • Full CommonMark/GFM compliance
  • The advertising/documentation is updated to say that compliance is not complete. And it does so prominently, otherwise it's dishonest.
@UziTech
Copy link
Member

UziTech commented Jul 2, 2020

PRs are welcome 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs Documentation changes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants