mirrors/nodejs
mirrors/nodejs
0
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-24 20:29:23 +01:00
Code Issues Releases Activity
0668e64cea
nodejs/doc/api_assets/README.md

8 lines
568 B
Markdown
Raw Normal View History

doc: update `api_assets` README for new files PR-URL: https://github.com/nodejs/node/pull/53676 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org>
2024-07-19 12:44:56 +02:00
# API documentation assets
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-16 21:54:24 +02:00
doc: update `api_assets` README for new files PR-URL: https://github.com/nodejs/node/pull/53676 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org>
2024-07-19 12:44:56 +02:00
* [`api.js`](./api.js): This file contains all the JavaScript used throughout the documentation.
* [`hljs.css`](./hljs.css): This CSS file is used for syntax highlighting styles in code blocks.
* [`js-flavor-cjs.svg`](./js-flavor-cjs.svg): This SVG image represents the toggle between ESM and CJS (_CJS_)
* [`js-flavor-esm.svg`](./js-flavor-esm.svg): This SVG image represents the toggle between ESM and CJS (_ESM_)
* [`style.css`](./style.css): This CSS file contains the styling rules for the overall appearance of the API documentation.
Copy Permalink