search

uwsampa / research-group-web

a template for research group sites
Other
185 stars 389 forks source link

Use kramdown instead redcarpet as markdown parser #3

Closed filipesaraiva closed 7 years ago

filipesaraiva commented 7 years ago

Since Jekyll 3.0 kramdown is the default library to parser markdown files [1]. Kramdown in fact is the default option, so there is no need to specify this library in _config.yml file [2].

[1] https://help.github.com/articles/updating-your-markdown-processor-to-kramdown/ [2] https://jekyllrb.com/docs/configuration/#default-configuration

sampsyo commented 7 years ago

Thanks for pointing that out! Doe switching to Kramdown not break anything in the template? (Also, do you happen to have the option at hand to turn on smart quotes in Kramdown?)

filipesaraiva commented 7 years ago

Thanks for pointing that out! Doe switching to Kramdown not break anything in the template?

The switching to kramdown in fact fixed a dependence error in the build. During the build (I am using Jekyll 3.4.1) I got this error message below:

  Conversion error: Jekyll::Converters::Markdown encountered an error while converting '_posts/2014-05-14-test.md':
                    redcarpet
             ERROR: YOUR SITE COULD NOT BE BUILT:
                    ------------------------------------
                    redcarpet

I could fix that installing the redcarpet gem, but just using the new default markdown parser this error message did not happen anymore.

Anyway, it can be interesting build the sampa public website with this parser to verify if there is some error.

filipesaraiva commented 7 years ago

(Also, do you happen to have the option at hand to turn on smart quotes in Kramdown?)

I think this answer in StackOverflow replies your question:

Looks like the smart quotes is turn on by default in kramdown.

sampsyo commented 7 years ago

OK; thanks for investigating!