search

ankitskvmdam / clean-jsdoc-theme

A beautifully crafted theme / template for JSDoc 3. https://ankdev.me/clean-jsdoc-theme/v4
https://www.npmjs.com/package/clean-jsdoc-theme
MIT License
171 stars 42 forks source link

The order function of the sections parameter is not effective #285

Open ximlu opened 6 months ago

ximlu commented 6 months ago

default_theme & sections order setting is not effective

{ "source": { "include": ["./Resources"], "excludePattern": "(node_modules/|docs)", "includePattern": ".js$" }, "opts": { "destination": "./docs", "template": "./node_modules/clean-jsdoc-theme", "encoding": "utf8", "undocumented": "strict" }, "plugins": [], "templates": { "cleverLinks": true, "monospaceLinks": true, "useLongnameInNav": false, "showInheritedInNav": true, "default": { "outputSourceFiles": false } }, "theme_opts": { "default_theme": "light", # not effective "sort": false, "search": true, "meta": [{ "name": "author", "content": "Hodor" }, { "name": "description", "content": "Powered by JSDoc3" } ], "sections": [ # not effective "Global", "Classes" ] } }

github-actions[bot] commented 6 months ago

Wonderful, you have created your first issue for clean-jsdoc-theme. Someone will talk to you soon!

ankitskvmdam commented 6 months ago

Hi @ximlu Thanks for creating this issue.

Could you also share the version of clean-jsdoc-theme you are using? Do you mind testing it for version 4.3.0?

For theme:

  1. clean-jsdoc-theme will use default_theme only if the user is visiting the webpage for the first time. After that clean-jsdoc-theme will look for theme in localStorage. Note that user can toggle theme using toggle theme button. image

  2. If you clear the localStorage then you will see the default theme.

For Sections: It is working as expected. If possible could you share a repo that I can use to reproduce the bug/error.

ankitskvmdam commented 4 months ago

Hi @ximlu Are you still facing the issue?