0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 23:16:30 +01:00
nodejs/doc/api_assets/README.md
Derek Lewis dc6c93c03e doc,tools: properly syntax highlight API ref docs
Prior to this commit, all <pre> tags were being
highlighted as JavaScript. This has been corrected
to syntax highlight all languages appearing in the
API reference docs. This was accomplished by using
highlight.js instead of SHJS for the frontend lib.

* remove SHJS JavaScript code
* add highlight.js bundle
* fix script tags to reflect replacement
* migrate CSS to use highlight.js classes
* add appropriate documentation
* ensure api_assets README.md stays interal

Fixes: https://github.com/nodejs/node/issues/33363

PR-URL: https://github.com/nodejs/node/pull/33442
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
2020-05-23 18:11:11 +02:00

28 lines
451 B
Markdown

# API Reference Document Assets
## highlight.pack.js
_Generated by [highlightjs.org/download][] on 2020-05-16._
Grammars included in the custom bundle:
* Bash
* C
* C++
* CoffeeScript
* JavaScript
* JSON
* Markdown
* Plaintext
* Shell Session
## hljs.css
The syntax theme for code snippets in API reference documents.
## style.css
The main stylesheet for API reference documents.
[highlightjs.org/download]: https://highlightjs.org/download/