Merged
Conversation
📦 Bundle sizeFull ESM build, minified and gzipped.
🌳 Bundle size after tree-shakingMinimal build including a renderer, camera, empty scene, and dependencies.
|
Collaborator
Author
|
@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. |
Collaborator
Author
|
Additional notes on the template:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: