Auto-generated jsdoc-default.css uses deprecated 'tt' css selector and duplicate of '.details ul' selector
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 65/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- css, javascript
- Domain
- documentation
Research direction
Read packages/jsdoc-template-legacy/static/styles/jsdoc-default.css, especially lines 57 and 259, and compare it with the generated docs/styles/jsdoc-default.css. Determine the intended treatment of the deprecated tt selector from its surrounding styles, remove the duplicate .details ul rule, then reinstall or regenerate JSDoc and verify the generated stylesheet no longer has these issues.
Written by the indexing model from the issue text.
Description
After installing jsdoc in a file, which is generated by default - jsdoc-default.css at docs/styles/, has deprecated css selector tt as well as a duplication of .details ul. I was able to find these small issues with SonarCloud, two screenshots below:
File at jsdoc source code at GitHub
File is a part of a jsdoc-template-legacy, located at:
https://github.com/jsdoc/jsdoc/blob/main/packages/jsdoc-template-legacy/static/styles/jsdoc-default.css (line 57 - tt tag and line 259 .details ul)
Steps to fix
While I understand how to fix .details ul - I will merge it with previous initialization, what should be done with tt selector? Should it stay as-is, or be replaced with something like pre?
Your environment
| Software | Version |
|---|---|
| JSDoc | 4.0.5 |
| Node.js | 26.5.0 |
| npm | 12.0.1 |
| Operating system | Arch Linux |
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from jsdoc/jsdoc
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Difficulty 3/5 1-2 days Newbie friendliness 50/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·