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.

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

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

Open
ximlu opened this issue Apr 26, 2024 · 3 comments
Open

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

ximlu opened this issue Apr 26, 2024 · 3 comments

Comments

@ximlu
Copy link

ximlu commented Apr 26, 2024

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"
]
}
}

Copy link

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

@ankitskvmdam
Copy link
Owner

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
Copy link
Owner

Hi @ximlu Are you still facing the issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants