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

Change default markdown parser #7417

Closed
ghost opened this issue Dec 12, 2018 · 6 comments
Closed

Change default markdown parser #7417

ghost opened this issue Dec 12, 2018 · 6 comments

Comments

@ghost
Copy link

ghost commented Dec 12, 2018

currently kramdown is the default parser:

http://jekyllrb.com/docs/configuration/default

however this has caused many issues, as kramdown is quite different from
CommonMark/GFM:

and the kramdown author is unwilling or unable to fix these issues, for several
years now. after some hand wringing i discovered that you can simply use
commonmark with github pages:

markdown: CommonMarkGhPages

http://github.com/github/jekyll-commonmark-ghpages

and you dont even have to declare the plugin in _config.yml as its activated
by default:

http://github.com/github/pages-gem/blob/fb5c3f2/lib/github-pages/plugins.rb#L9

@pathawks
Copy link
Member

What is the issue? This does not appear to be actionable.

@ghost
Copy link
Author

ghost commented Dec 12, 2018

@pathawks per my original post - this page

http://jekyllrb.com/docs/configuration/default

lists "kramdown" as the markdown parser - i am requesting to change that to
"CommonMarkGhPages" both in the documentation and in appropriate places in the actual code

@pathawks
Copy link
Member

i am requesting to change that to
"CommonMarkGhPages" both in the documentation and in appropriate places in the actual code

CommonMarkGhPages Does not ship with Jekyll by default. There is some talk of using CommonMark as our default Markdown converter in v4, but it requires C extensions which has been a particular pain point for users installing Jekyll.

This is much larger than just a documentation change.

@DirtyF
Copy link
Member

DirtyF commented Dec 13, 2018

Currently jekyll-commonmark is only mentioned on the plugins listing.

We could add a note on https://jekyllrb.com/docs/configuration/markdown/

@jekyllbot
Copy link
Contributor

This issue has been automatically marked as stale because it has not been commented on for at least two months.

The resources of the Jekyll team are limited, and so we are asking for your help.

If this is a bug and you can still reproduce this error on the latest 3.x-stable or master branch, please reply with all of the information you have about it in order to keep the issue open.

If this is a feature request, please consider building it first as a plugin. Jekyll 3 introduced hooks which provide convenient access points throughout the Jekyll build pipeline whereby most needs can be fulfilled. If this is something that cannot be built as a plugin, then please provide more information about why in order to keep this issue open.

This issue will automatically be closed in two months if no further activity occurs. Thank you for all your contributions.

@jekyllbot jekyllbot added stale Nobody stepped up to work on this issue. and removed stale Nobody stepped up to work on this issue. labels Mar 29, 2019
@DirtyF
Copy link
Member

DirtyF commented Mar 29, 2019

For now, people can switch to CommonMark by using the plugins.
https://jekyllrb.com/docs/configuration/markdown/#commonmark

We might merge both commonMark plugins and make CommonMark GFM available in Jekyll in a future release.

@DirtyF DirtyF closed this as completed Mar 29, 2019
@jekyll jekyll locked and limited conversation to collaborators Jun 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants