Deprecate Maruku in docs #2348

Closed
wants to merge 2 commits into
from

Conversation

Projects
None yet
4 participants
@yizeng
Contributor

yizeng commented May 8, 2014

As we use kramdown as Jekyll's default markdown engine now (#1988), it might be a good idea to update related documentation.

Questions:

  • kramdown states it's called kramdown, not Kramdown. (Personally I found this annoying though.) Do we need to reflect this in our documentation to use lower case?
  • I'm not sure how we should deal with LatexSupport section for kramdown. Should we simply remove this section (that link is 404 anyway)? Or figure out and document something like LaTeX Converter?
    I'm removing this section for now, but we can add it back in if someone actually has tested kramdown's LaTex support.
  • Is there a reason we still have redcarpet as run-time dependency? This has been brought up in #2285, but @parkr didn't answer about redcarpet. (No actions will be taken in this PR though)
@yizeng

This comment has been minimized.

Show comment Hide comment
@yizeng

yizeng May 8, 2014

Owner

kramdown is the default engine now, therefore no need to document it in "Extras" anymore, as Configuration should have them all covered.

kramdown is the default engine now, therefore no need to document it in "Extras" anymore, as Configuration should have them all covered.

@parkr

This comment has been minimized.

Show comment Hide comment
@parkr

parkr May 9, 2014

Member

This feels more like "removal" than "deprecation". We'll want this for sure come 3.0.0, but not quite yet. Thank you for being so on-top of this though! 😄

Member

parkr commented May 9, 2014

This feels more like "removal" than "deprecation". We'll want this for sure come 3.0.0, but not quite yet. Thank you for being so on-top of this though! 😄

@parkr parkr closed this May 9, 2014

@yizeng yizeng deleted the yizeng:deprecate-maruku-in-docs branch May 9, 2014

@mchelen

This comment has been minimized.

Show comment Hide comment
@mchelen

mchelen Jul 7, 2014

Why not merge this now? Using the current version of Jekyll means that the website documentation is inaccurate.

mchelen commented Jul 7, 2014

Why not merge this now? Using the current version of Jekyll means that the website documentation is inaccurate.

@parkr

This comment has been minimized.

Show comment Hide comment
@parkr

parkr Jul 7, 2014

Member

@mchelen While Maruku isn't default, we still support it. 80% of this PR is to remove existing Maruku docs, which we'd rather keep.

Member

parkr commented Jul 7, 2014

@mchelen While Maruku isn't default, we still support it. 80% of this PR is to remove existing Maruku docs, which we'd rather keep.

@mchelen

This comment has been minimized.

Show comment Hide comment
@mchelen

mchelen Jul 7, 2014

@parkr Oh ok, I just wanted to update things like "While Jekyll defaults to using Maruku for Markdown conversion" on http://jekyllrb.com/docs/extras/
Would it be ok for me to do that or does it need to wait?

mchelen commented Jul 7, 2014

@parkr Oh ok, I just wanted to update things like "While Jekyll defaults to using Maruku for Markdown conversion" on http://jekyllrb.com/docs/extras/
Would it be ok for me to do that or does it need to wait?

@parkr

This comment has been minimized.

Show comment Hide comment
@parkr

parkr Jul 7, 2014

Member

@mchelen Yep, that would be fine! Just shoot me a PR and I'll merge. 😄

Member

parkr commented Jul 7, 2014

@mchelen Yep, that would be fine! Just shoot me a PR and I'll merge. 😄

@jekyllbot jekyllbot locked and limited conversation to collaborators Feb 27, 2017

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.