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

Use CommonMark instead of loosely defined Markdown flavour #361

Closed
dumblob opened this issue Mar 8, 2015 · 4 comments
Closed

Use CommonMark instead of loosely defined Markdown flavour #361

dumblob opened this issue Mar 8, 2015 · 4 comments

Comments

@dumblob
Copy link

@dumblob dumblob commented Mar 8, 2015

I think that for documentation purposes, the syntax should be precisely defined in advance to allow long-term maintainability, which Gruber's Markdown doesn't fulfill. Therefore I'm suggesting switching from Markdown to CommonMark (there is an existing module https://github.com/rolandshoemaker/CommonMark-py).

@d0ugal

This comment has been minimized.

Copy link
Member

@d0ugal d0ugal commented Mar 8, 2015

I don't think I see why documentation specifically needs the syntax to be more less precisely defined than other prose, but that is another discussion :)

CommonMark is an intersting project, I appreciate it's goals and may be a direction we wish to take at some point. However, at present it is too young and I don't see any real advantages to switching at this point.

So, we should take note of this and keep an eye on it for the future.

@d0ugal d0ugal closed this Mar 8, 2015
@dumblob

This comment has been minimized.

Copy link
Author

@dumblob dumblob commented Mar 8, 2015

Ok, understood. The nice feature of CommonMark is, that it's backwards compatible, which is the reason why I proposed it even if the spec is still "too young".

@d0ugal

This comment has been minimized.

Copy link
Member

@d0ugal d0ugal commented Mar 8, 2015

Not just the spec, the implementations too and general uptake. I'll continue to keep an eye on it.

@d0ugal

This comment has been minimized.

Copy link
Member

@d0ugal d0ugal commented Mar 9, 2015

It's also worth noting that we heavily rely on the Python-Markdown extension system to hook into the build process and grab various bits of information and so on. It is likely that it would be a more disruptive change than you imagine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.