search

github / pages-gem

A simple Ruby Gem to bootstrap dependencies for setting up and maintaining a local Jekyll environment in sync with GitHub Pages
http://pages.github.com
MIT License
1.82k stars 349 forks source link

Change default markdown parser #605

Open ghost opened 5 years ago

ghost commented 5 years ago

currently kramdown is the default parser:

https://github.com/github/pages-gem/blob/fb5c3f22a5789aee30c942e30962a69a8ac75e3a/lib/github-pages/configuration.rb#L20

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:

https://github.com/github/pages-gem/blob/fb5c3f22a5789aee30c942e30962a69a8ac75e3a/lib/github-pages/plugins.rb#L7-L9

fuzzy76 commented 5 years ago

A better way to fix this IMHO would be to update kramdown to a recent version, as all of those issues are fixed.