Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Trying out Maruku 0.7.0 #1558

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
Owner

parkr commented Sep 16, 2013

  • Fix any API incompatibilities
  • Fix all botched tests

/cc @bhollis

Ref: github/pages-gem#20

rmzelle commented Oct 1, 2013

Note that maruku 0.7.0 final was released a few days ago: http://rubygems.org/gems/maruku/versions/0.7.0

Owner

parkr commented Nov 10, 2013

Seems to be mostly newline issues and there's one random <hr> in there too, curiously.

Owner

mattr- commented Nov 11, 2013

Despite the fact that Maruku may indeed be obsolete, we're committed to maintaining backwards compatibility until jekyll 2.0, which means that we still need to keep up with Maruku until then, as it is still our default.

Is there a schedule to upgrade to maruku 0.7.0?
Thanks!

Owner

mattr- commented Nov 12, 2013

No schedule.

Contributor

bhollis commented Nov 13, 2013

Just to note - Maruku is obsolete (because Kramdown is better) but it is still supported.

Contributor

bhollis commented Nov 13, 2013

@parkr, could you let me know what issues you've encountered?

Owner

parkr commented Nov 13, 2013

@bhollis The issues are all in the travis build :) The failing unit tests are changed behaviours since 0.6.x.

Contributor

gregkare commented Nov 25, 2013

It looks like #1672 updated to maruku 0.7.0 and fixed the failing tests, but a rebase has gone (way) wrong.

@Ivoz Can you move your three commits to a clean fork of the master branch?

Owner

parkr commented Nov 25, 2013

@gregkare Rebased.

Contributor

konklone commented Dec 4, 2013

Now that it's been rebased, could this be merged? Though Maruku is obsolete, 0.7.0 does add a very important feature, which is support for fenced code blocks.

To explain why this is important - I'm trying hard to move a @sunlightlabs API project's docs to a Jekyll-based, GH-hosted solution. It's currently on GH Pages, but uses DocumentUp and freezes the HTML into the repository.

Right now, neither Redcarpet, Maruku, or Kramdown can be used with Github Pages while supporting each of fenced code blocks with backticks and table of contents generation.

With Redcarpet, the issue is that it's an alternate renderer, not an extension, so Jekyll has no way to turn it on right now. With Kramdown, it recently added an alternate GFM parser, but it is not yet supported in Jekyll or GH Pages.

The easiest thing is to just bump up Maruku. So, updating Jekyll to support Maruku 0.7.0, and then Github Pages bumping its Jekyll version, would allow a richer level of publication using Github Pages.

@konklone konklone referenced this pull request in github/pages-gem Dec 4, 2013

Closed

Upgrade the maruku dependency request #28

Contributor

benbalter commented Dec 4, 2013

@konklone they absolutely have to be backticks and can't be tildes? Kramdown supports ToC generation... would hate for you to get locked into an already EOL piece of software.

Contributor

konklone commented Dec 4, 2013

Backticks are what Github supports, and what we've been using. I don't want to have to go and update all of our documents to use tildes, and then have them no longer work when viewed inside Github.

Github Pages and Jekyll should, together, be able to use the same fenced code block syntax that Github.com supports.

Jekyll/GHP could also start supporting Kramdown's GFM parser, or Redcarpet's TOC generation renderer -- those would also solve the problem. Bumping Maruku support seems the quickest fix.

Contributor

benbalter commented Dec 4, 2013

Github Pages and Jekyll should, together, be able to use the same fenced code block syntax that Github.com supports... Bumping Maruku support seems the quickest fix.

👍 on both fronts

Owner

parkr commented Dec 4, 2013

So my problem here is that 0.7.0 doesn't follow SemVer and 0.6.x => 0.7.0 breaks compatibility. As it's the default, this would result in a bunch of broken websites and I'm not sure we want to do that. Any way to minimize animosity toward Jekyll, the better.

Contributor

benbalter commented Dec 4, 2013

breaks compatibility

As in breaking changes? Looking through the changelog, beyond the idiosyncrasies of our own tests, it looks like bugfixes, no?

Contributor

konklone commented Dec 5, 2013

I opened tickets (#1773, #1774) to do related fixes for Kramdown and Redcarpet. Addressing either of them would diminish the importance of this ticket (though it seems worth doing regardless).

Contributor

bhollis commented Dec 5, 2013

Maruku 0.7.0 should not break backwards compatibility except for instances
where the existing behavior was obviously broken. If you are seeing a
breaking change please file an issue and I will fix it.

-Ben

Sent from my phone

On Dec 4, 2013, at 2:55 PM, Parker Moore notifications@github.com wrote:

So my problem here is that 0.7.0 doesn't follow SemVer and 0.6.x => 0.7.0
breaks compatibility. As it's the default, this would result in a bunch of
broken websites and I'm not sure we want to do that. Any way to minimize
animosity toward Jekyll, the better.


Reply to this email directly or view it on
GitHubhttps://github.com/mojombo/jekyll/pull/1558#issuecomment-29854670
.

Contributor

Ivoz commented Dec 5, 2013

I updated my PR to master with #1775 for Maruku 0.7, cheers @gregkare

@parkr parkr referenced this pull request Dec 5, 2013

Merged

Update to maruku 0.7 #1775

@parkr parkr closed this Dec 5, 2013

@parkr parkr deleted the maruku-beta branch Dec 5, 2013

Contributor

konklone commented Dec 9, 2013

So...there are unfortunately a couple problems, now that I've dug into getting Maruku 0.7.0's fenced_code_blocks setting working in practice:

  1. Jekyll whitelists Maruku options, and doesn't just pass them in, which I was confused about -- so, Jekyll needs a further patch to support fenced_code_blocks. I have an in-progress patch to fix this, but I'm getting stuck on getting pygments to turn on, and thus to get a working test case for it.
  2. Even if I can patch Jekyll, and get pygments to turn on, it looks like Maruku is inserting an unwanted newline after the opening of the <code> block, which carries through to the generated markup, like this:

error

Maybe I'm just missing something, and I'm more than happy to turn these two issues into their own threads. I wish I'd dug into this before Jekyll 1.4.0 was released, but things moved fast and I couldn't get to it until today.

If it's at all helpful, I've taken the time to document the state of affairs in Maruku, Kramdown, and Redcarpet here.

Contributor

bhollis commented Dec 9, 2013

@konklone, could you please file an issue about the <code> newline issue at https://github.com/bhollis/maruku/issues ? That sounds like a bug, and I'd be happy to track it down and fix it if you'll give me a sample of the Markdown you've written and the output you expect.

Contributor

Ivoz commented Dec 9, 2013

@bhollis I did have to add this change when updating the maruku parser for jekyll, I'm not sure if that's at all related or if you know why extra new lines were surrounding maruku's output from 0.6->0.7?

Contributor

konklone commented Dec 9, 2013

Thanks @bhollis -- I filed bhollis/maruku#111 with the issue.

Contributor

konklone commented Dec 9, 2013

And for reference, @Ivoz, I think the two issues are unrelated, because your newline issue (surrounding the entire output) affects both fenced and indented code blocks, whereas mine (surrounding the innards of a <code> block) only affects fenced code blocks.

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