Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Deprecate Maruku in docs #2348

Closed
wants to merge 2 commits into from

3 participants

@yizeng

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

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

@parkr
Owner

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! :smile:

@parkr parkr closed this
@yizeng yizeng deleted the yizeng:deprecate-maruku-in-docs branch
@mchelen

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

@parkr
Owner

@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

@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
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
View
8 site/docs/configuration.md
@@ -366,14 +366,6 @@ baseurl: ""
url: http://localhost:4000
lsi: false
-maruku:
- use_tex: false
- use_divs: false
- png_engine: blahtex
- png_dir: images/latex
- png_url: /images/latex
- fenced_code_blocks: true
-
rdiscount:
extensions: []
View
34 site/docs/extras.md
@@ -9,22 +9,15 @@ permalink: /docs/extras/
There are a number of (optional) extra features that Jekyll supports that you
may want to install, depending on how you plan to use Jekyll.
-## LaTeX Support
-
-Maruku comes with optional support for LaTeX to PNG rendering via blahtex
-(Version 0.6) which must be in your `$PATH` along with `dvips`. If you need
-Maruku to not assume a fixed location for `dvips`, check out [Remi’s Maruku
-fork](http://github.com/remi/maruku).
-
## Alternative Markdown Processors
-While Jekyll defaults to using Maruku for Markdown conversion, you may use one
-of the other three pre-defined markdown parsers or define your own.
+While Jekyll defaults to using kramdown for Markdown conversion, you may use one
+of the other pre-defined markdown parsers or define your own.
### RDiscount
If you prefer to use [RDiscount](http://github.com/rtomayko/rdiscount) instead
-of [Maruku](http://github.com/bhollis/maruku) for Markdown, just make sure you have
+of [kramdown](http://kramdown.gettalong.org/) for Markdown, just make sure you have
it installed:
{% highlight bash %}
@@ -39,27 +32,6 @@ have Jekyll run with that option.
markdown: rdiscount
{% endhighlight %}
-### Kramdown
-
-You can also use [Kramdown](http://kramdown.rubyforge.org/) instead of Maruku
-for Markdown. Make sure that Kramdown is installed:
-
-{% highlight bash %}
-$ [sudo] gem install kramdown
-{% endhighlight %}
-
-Then you can specify Kramdown as the Markdown engine in `_config.yml`.
-
-{% highlight yaml %}
-# In _config.yml
-markdown: kramdown
-{% endhighlight %}
-
-Kramdown has various options for customizing the HTML output. The
-[Configuration](/docs/configuration/) page lists the default options used by
-Jekyll. A complete list of options is also available on the [Kramdown
-website](http://kramdown.rubyforge.org/options.html).
-
### User-Defined
So, you're totally at odds with our four built-in markdown parsers, eh? No
View
6 site/docs/quickstart.md
@@ -21,9 +21,9 @@ posts, using the front-matter to control templates and layouts, and taking
advantage of all the awesome configuration options Jekyll makes available.
<div class="note info">
- <h5>Redcarpet is the default Markdown engine for new sites</h5>
- <p>In Jekyll 1.1, we switched the default markdown engine for sites
- generated with <code>jekyll new</code> to Redcarpet</p>
+ <h5>kramdown is the default Markdown engine for new sites</h5>
+ <p>In Jekyll 2.0.0, we switched the default markdown engine for sites
+ generated with <code>jekyll new</code> to kramdown.</p>
</div>
If you're running into problems, ensure you have all the [requirements
View
15 site/docs/troubleshooting.md
@@ -104,21 +104,6 @@ The various markup engines that Jekyll uses may have some issues. This
page will document them to help others who may run into the same
problems.
-### Maruku
-
-If your link has characters that need to be escaped, you need to use
-this syntax:
-
-{% highlight text %}
-![Alt text](http://yuml.me/diagram/class/[Project]->[Task])
-{% endhighlight %}
-
-If you have an empty tag, i.e. `<script src="js.js"></script>`, Maruku
-transforms this into `<script src="js.js" />`. This causes problems in
-Firefox and possibly other browsers and is [discouraged in
-XHTML.](http://www.w3.org/TR/xhtml1/#C_3) An easy fix is to put a space
-between the opening and closing tags.
-
### RedCloth
Versions 4.1.1 and higher do not obey the notextile tag. [This is a known
Something went wrong with that request. Please try again.