Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update api_assets README for new files #53676

Merged
merged 1 commit into from
Jul 19, 2024
Merged

doc: update api_assets README for new files #53676

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions doc/api_assets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading