Repository navigation
doc: all <pre> tags are highlighted as JavaScript #33363
Description
Activity
Yes, please fix this! 😀
Reacted by Derek Lewis@Trott, it is my impression that this would be an excellent opportunity to switch to highlight.js for a few reasons:
- SHJS hasn't been updated in 6 years
- SHJS is GPL v3 licensed
- SHJS doesn't understand modern language syntax
- highlight.js is currently well-maintained (and popular)
- highlight.js is BSD licensed
- highlight.js is able to highlight the modern syntax of several languages
- we'd have syntax highlighting on par w/ the Markdown docs rendered on GitHub.com
I think there was a reason why @zeke mentioned it in passing — it's the route to go nowadays. If GitHub's syntax highlighting library (Prettylights) were OSS, we'd ideally use that, but that doesn't seem to be one of our options. I can give it a day or two before proceeding in case others want to shop around and propose a superior frontend syntax highlighting library, but this seems like the best bet as far as I can tell.
/cc @nodejs/documentation
Reacted by Richard Lau and Rich Trott- added a commit that references this issue
on May 23, 2020 - added 2 commits that reference this issue
on Jun 18, 2020 - added a commit that references this issue
on Jun 30, 2020 - added a commit that references this issue
on Jul 8, 2020 Hi folks! As this discussion mentions ideally using PrettyLights by GH, I wanted to drop a suggestion for a project which I made that does exactly that: https://github.com/wooorm/starry-night. HLJS is much lighter, but if y’all are noticing problems,
starry-nightmight be a good choice!Reacted by Zeke Sikelianos
📗 API Reference Docs Problem
Location
Section of the site where the content exists
Affected URL(s):
Problem description
Concise explanation of what you found to be problematic
While looking into #32938, I discovered that currently, every single <pre> tag gets highlighted as JavaScript regardless of the info string specified (and even if left unspecified). The following line executes the code that does this.
node/doc/template.html
Line 56 in 94e5b5c
This behavior can be observed in the C++ code blocks in the published API reference documents. The following line is the reason for this — the language has been hard-coded.
node/doc/api_assets/sh_main.js
Line 542 in 94e5b5c
^ I'm currently on summer vacation, so I would have the time to work on this.
/cc @Trott