Fenced Code Blocks with classes and ID's do not work

Question

Fenced Code Blocks with classes and ID's do not work

lakhman opened this issue 9 years ago · comments

Anil commented 9 years ago

Hi,

https://michelf.ca/projects/php-markdown/extra/#fenced-code-blocks

I noticed this small issue with fenced code blocks:

The following:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.html #example-1}
<p>paragraph <b>emphasis</b>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Should parse into:

<pre><code id="example-1" class="html">&lt;p&gt;paragraph &lt;b&gt;emphasis&lt;/b&gt;
</code></pre>

but actually gives:

<p><del>~</del><del>~</del><del>~</del><del>~</del><del>~</del>~~~ {.html #example-1}</p>
<p>paragraph <b>emphasis</b>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~</p>

This would be incredibly useful for syntax highlighting amongst other stuff.

Thanks!

Tom Turton commented 9 years ago

+1

Jerry van Kooten · Answer 1 · Tue Jun 23 2015 04:10:05 GMT+0800 (China Standard Time)

Another difference between Markdown Extra and Parsedown Extra when you have a fenced block with just "someclass" following it (I can't finish the example since GFM doesn't like nested blocks; not sure how Lakhman did it!):

   ~~~ someclass

ME:

<pre><code class="someclass">code</code></pre>

PE:

<pre><code class="language-someclass">code</code></pre>

I hope there will be a difference between a fenced block with a language type (class="language-someclass") and an extra class (class="someclass") so I could even have class="language-html best-example".

willstocks · Answer 2 · Fri Jul 26 2019 20:34:09 GMT+0800 (China Standard Time)

@erusev - do you know if this is/will be fixed? I recently started using OctoberCMS and realised Parsedown + Parsedown Extra are included by default, but noticed that adding a class/ID to a code block doesn't work when writing either markdown page content or a blog post using rainlab's blog plugin (please see rainlab/blog-plugin#457)

Emanuil Rusev · Answer 3 · Sat Jul 27 2019 15:52:17 GMT+0800 (China Standard Time)

@aidantwoods do you have any thoughts on this

Aidan Woods · Answer 4 · Sat Jul 27 2019 19:11:45 GMT+0800 (China Standard Time)

I don't foresee any issues with supporting this for fenced code blocks, I'll have a go later today. As @lakhman points out, this is something that should work per the extra spec, so it should probably be supported here :)

willstocks · Answer 5 · Tue Jul 30 2019 21:54:27 GMT+0800 (China Standard Time)

Thanks @aidantwoods 😁 Looking forward to it!

Taufik Nurrohman · Answer 6 · Wed Jul 31 2019 20:22:38 GMT+0800 (China Standard Time)

@lakhman Read this section to add custom classes without language- prefix in Markdown Extra using my extension. Currently compatible for Parsedown Extra 0.7.0.

Update: #133

willstocks · Answer 7 · Mon Aug 05 2019 23:22:20 GMT+0800 (China Standard Time)

@aidantwoods / @erusev - is @tovic's solution a viable solution that will be backed into PE or will you guys have an alternate/formal solution for this?

I only ask because obviously Parsedown + Parsedown Extra are bundled into October and it'd be great to not have to fudge something together 😁

willstocks · Answer 8 · Tue Aug 13 2019 22:15:52 GMT+0800 (China Standard Time)

Any luck with this one @aidantwoods?

willstocks · Answer 9 · Mon Sep 02 2019 22:55:49 GMT+0800 (China Standard Time)

Hey @aidantwoods / @erusev
Don't suppose you happen to have any update on this one? Or maybe is it worth @tovic putting in a PR for this functionality? Would be nice to see this "native" in October/in other places PE is used :)

Taufik Nurrohman · Answer 10 · Tue Sep 03 2019 13:55:52 GMT+0800 (China Standard Time)

@willstocks I could, but looking at the philosophy of Parsedown, they seem to prefer simplicity. That is to simply process Markdown input to HTML according to the CommonMark specs without providing many complicated options. So, it would still be better if the advanced configuration is available as a separate plugin.

willstocks · Answer 11 · Fri Sep 06 2019 22:12:16 GMT+0800 (China Standard Time)

@tovic whilst I agree with you that they like to keep things simple, Parsedown Extra (which is, in itself, an extension of Parsedown) adds support for Markdown Extra, which includes this functionality (https://michelf.ca/projects/php-markdown/extra/#fenced-code-blocks) for code blocks therefore in theory this should be supported as standard within PE?

Markdown Extra example (from link above):

You can specify a class name that will apply to a code block. This is useful if you want to style differently code blocks depending on the language. Or you could also use it to tell a syntax highlighter what syntax to use.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .html
paragraph emphasis
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The class name is placed at the end of the first fence. It can be preceded by a dot, but this is not a requirement. You can also use a special attribute block:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.html #example-1}
paragraph emphasis
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Taufik Nurrohman · Answer 12 · Fri Sep 06 2019 23:04:22 GMT+0800 (China Standard Time)

From this commit, I can see that @aidantwoods is deliberately limiting the class names that are allowed in the code block attribute to just one class name. Somehow, maybe to prevent XSS.

willstocks · Answer 13 · Fri Sep 06 2019 23:21:32 GMT+0800 (China Standard Time)

@aidantwoods is there a reason for this restriction? Would you be open to @tovic submitting a PR (if he's happy to that is!!!) considering he has already extended this functionality externally or would you prefer to handle extending class/id's to code blocks within existing PE contributors?