-
-
Notifications
You must be signed in to change notification settings - Fork 36.2k
JSDoc: Add custom template. #30449
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.
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
JSDoc: Add custom template. #30449
Conversation
📦 Bundle sizeFull ESM build, minified and gzipped.
🌳 Bundle size after tree-shakingMinimal build including a renderer, camera, empty scene, and dependencies.
|
|
@mrdoob I'm not a CSS expert but I hope the styles are appropriate. If you think this template is a good replacement for the existing docs, I'll start to migrate the remaining modules in the repository to JSDoc. I'll also add documentation for all Addons which are undocumented so far. |
|
Additional notes on the template:
|
Related issue: -
Description
This PR adds a custom JSDoc template for generating the documentation pages. It uses the fonts, styles and site structure from the original documentation. The template is based on the default JSDoc theme and enhanced with search features from
clean-jsdoc-theme.Page View:
There is now a client-side search:
The sidebar supports two hierarchies as before (category-subcategory). E.g. "Core -> Materials or "Addons -> TSL"
Mobile-View:
Code Sections: