Skip to content

Document Kramdown/Maruku problems WRT options #135

Closed
gioele opened this Issue Feb 16, 2012 · 3 comments

2 participants

@gioele
gioele commented Feb 16, 2012

I read in the TEMPLATES.md

Every implementation of Markdown should support these options, but there are some known problems with the Kramdown and Maruku engines.

Could you please document these issues? The source code for Kramdown and Maruku is very small and clean, no problems are highlighted in the comments and the issues on GH do not show any problem with options (aside :smart_quotes, but that is handled just fine by the current code). Maybe that paragraph is a leftover from previous versions of Tilt?

@judofyr
Collaborator
judofyr commented May 1, 2013

This might have been a leftover from a previous version. I'll have a look at it.

@judofyr
Collaborator
judofyr commented May 2, 2013

The Markdown tests actually show this very clearly: https://github.com/rtomayko/tilt/blob/a80ce035be67c1439f4d1d7b4ac64c4f557a9e71/test/tilt_markdown_test.rb#L130

begin
  require 'kramdown'

  class MarkdownKramdownTest < Test::Unit::TestCase
    include MarkdownTests
    template Tilt::KramdownTemplate
    # Doesn't support escaping
    undef test_escape_html_true
    # Smarty Pants is *always* on, but doesn't support it fully
    undef test_smarty_pants
    undef test_smarty_pants_false
    undef test_smarty_pants_true
  end
rescue LoadError => boom
  # It should already be warned in the main tests
end


begin
  require 'maruku'

  class MarkdownMarukuTest < Test::Unit::TestCase
    include MarkdownTests
    template Tilt::MarukuTemplate
    # Doesn't support escaping
    undef test_escape_html_true
    # Doesn't support Smarty Pants, and even fails on ``Foobar''
    undef test_smarty_pants
    undef test_smarty_pants_false
    undef test_smarty_pants_true
    # Smart Quotes is always on
    undef test_smart_quotes
    undef test_smart_quotes_false
  end
rescue LoadError => boom
  # It should already be warned in the main tests
end
@judofyr judofyr referenced this issue May 12, 2013
Open

Add better documentation #189

2 of 4 tasks complete
@judofyr
Collaborator
judofyr commented May 12, 2013

I'm moving this under #189.

@judofyr judofyr closed this May 12, 2013
@Announcement Announcement added a commit to Announcement/tilt that referenced this issue Jun 25, 2016
@Announcement Announcement issue #135 documentation e1283e2
@Announcement Announcement referenced this issue Jun 25, 2016
Closed

Docs #289

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.