opengovfoundation/madison

With Markdown enabled double tilde strikethrough does not work in v.4

IuliiSe opened this issue · 3 comments

IuliiSe commented

Instead of getting a strikethrough text the pair of tildes are rendered as text. It work while text is being edited, but fails when text is in preview mode.

dbiere commented

The issue is that SimpleMDE (used during editing) enables strikethrough by default, while the Laravel-Markdown CommonMark wrapper library (used for viewing the doc) does not support strikethrough.

From the SimpleMDE config guide...

strikethrough: If set to false, will not process GFM strikethrough syntax. Defaults to true.

The Markdown and CommonMark specs do not mention strikethrough/strikeout at all.

So it seems our options are:

  1. Disable SimpleMDE strikethrough, or
  2. Enable Laravel-Markdown strikethrough via a CommonMark extension such as commonmark-ext

I'd be happy to work on this but would appreciate guidance from the group. Which option makes the most sense? Should Madison stick closer to the Markdown spec or support common extensions like strikethrough?

dbiere commented

Do you have any thoughts on this @sethetter?

sethetter commented

@dbiere apologies for the delay! I think it's sufficient to simply disable the SimpleMDE strike through. We haven't seen too many attempted uses of the feature and can always add to it later.