doc: update api_assets README for new files

PR-URL: #53676 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Claudio Wunder <[email protected]>
nodejs · Aug 19, 2024 · 233aba9 · 233aba9
1 parent b71250a
commit 233aba9
Showing 1 changed file with 6 additions and 12 deletions.
diff --git a/doc/api_assets/README.md b/doc/api_assets/README.md
@@ -1,13 +1,7 @@
-# API Reference Document Assets
+# API documentation assets
 
-## api.js
-
-The main script for API reference documents.
-
-## hljs.css
-
-The syntax theme for code snippets in API reference documents.
-
-## style.css
-
-The main stylesheet for API reference documents.
+* [`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.