Switch to Highlight.JS from PrismJS - Discuss

[FlipperPA]

PrismJS no longer seems to be maintained. There are also some underlying issues with CSS namespacing that conflict with Wagtail's admin, particularly around the CSS class named comment.

I'm considering switching to highlight.js as our underlying syntax highlighting library.

Pros:

• Resolves namespace conflicts
• Actively maintained
• More language support
• More theme choice

Cons:

• Current themes will no longer be supported
• It's a big change, and other backwards incompatibilities might be found.

I wanted to open this issue for discussion to our users before moving in this direction. Thoughts?

[vsalvino]

If you wanted to switch to backend rendering / pygments, I have my old implementation archived here, which you're free to rip off: https://github.com/vsalvino/coderedcms-codeblock

The one thing I'd do differently is change the language list dropdown to a user-entered string instead, as the list is HUGE.

[smark-1]

Highlight.js does not support line numbering. Is line numbering going to still be supported?

[FlipperPA]

@smark-1 There seems to be a plugin we can leverage, but good question:

https://github.com/wcoder/highlightjs-line-numbers.js/

[smark-1]

The current versioning is based off of PrismJS. What would the versioning scheme be after switching?

[FlipperPA]

@smark-1 That's a great question. We might fork this to something like wagtail-highlight-js and start with HighlightJS versioning. Unfortunately, I haven't had the time to work on this, and there hasn't been a need at work.