Repository navigation
doc: all <pre> tags are highlighted as JavaScript #33363
Description
📗 API Reference Docs Problem
- Version: n/a
- Platform: n/a
- Subsystem: n/a
Location
Section of the site where the content exists
Affected URL(s):
- https://nodejs.org/api/embedding.html
- Any other document w/ a Markdown code fence
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.
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 would like to work on this issue and submit a pull request.
^ I'm currently on summer vacation, so I would have the time to work on this.
/cc @Trott
Activity
Trott commentedon May 12, 2020
Yes, please fix this! 😀
DerekNonGeneric commentedon May 14, 2020
@Trott, it is my impression that this would be an excellent opportunity to switch to highlight.js for a few reasons:
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
zeke commentedon May 14, 2020
☝️ Yep that is why I mentioned it.
doc,tools: properly syntax highlight API ref docs
doc,tools: properly syntax highlight API ref docs
doc,tools: properly syntax highlight API ref docs
doc,tools: properly syntax highlight API ref docs
doc,tools: properly syntax highlight API ref docs
wooorm commentedon May 14, 2022
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!