From 233aba90ea0907d8720f4285fcfc081b7b6bb12d Mon Sep 17 00:00:00 2001 From: Aviv Keller <38299977+RedYetiDev@users.noreply.github.com> Date: Fri, 19 Jul 2024 06:44:56 -0400 Subject: [PATCH] doc: update `api_assets` README for new files PR-URL: https://github.com/nodejs/node/pull/53676 Reviewed-By: Luigi Pinca Reviewed-By: James M Snell Reviewed-By: Claudio Wunder --- doc/api_assets/README.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/doc/api_assets/README.md b/doc/api_assets/README.md index e2c1d90cd0953f..b5d55c09b85169 100644 --- 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.