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

Replace Parsedown Extra (Markdown Extra) with CommonMark #156

Open
6 of 10 tasks
mnapoli opened this issue Apr 3, 2016 · 2 comments
Open
6 of 10 tasks

Replace Parsedown Extra (Markdown Extra) with CommonMark #156

mnapoli opened this issue Apr 3, 2016 · 2 comments

Comments

@mnapoli
Copy link
Member

mnapoli commented Apr 3, 2016

Couscous supports Markdown Extra. To achieve that, the parser used is Parsedown Extra.

However we might want to switch to using the League/CommonMark parser because:

  • CommonMark is a new and improved standard for Markdown
  • League/CommonMark parses Markdown into an AST that can be extended and manipulated before being rendered to HTML

That would make it easier to add features such as #39, #65, #69, #155, etc.

Problem: in order to preserve BC we need Markdown Extra's features to be supported by Couscous:

IMO we could get rid of definition lists, footnotes and abbreviations. I am not against adding support later if someone writes an extension for that, but I don't think they are crucial features.

That could be considered a BC break though given all the small differences. I'm not against releasing it as Couscous 2.0, thoughts? We could ship it with many features implemented thanks to that.

mnapoli added a commit that referenced this issue Apr 3, 2016
mnapoli added a commit that referenced this issue Apr 3, 2016
@mnapoli
Copy link
Member Author

mnapoli commented Apr 3, 2016

I have added tests for the features described above in #157.

@wysow
Copy link
Member

wysow commented Apr 4, 2016

Sounds great to release this as version 2.0 for me, Definition Lists, Footnotes and Abbreviations could definitely be implemented later as you said...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants