docs: Update jsdoc template for better usability on mobile #8048
Conversation
| "template": "node_modules/tui-jsdoc-template", | ||
| "package": "package.json", | ||
| "template": "node_modules/clean-jsdoc-theme", | ||
| "package": "", |
There was a problem hiding this comment.
with this theme, this keeps the output in the root of the destination dir and not at package/version/
Codecov Report
@@ Coverage Diff @@
## main #8048 +/- ##
==========================================
+ Coverage 82.00% 82.01% +0.01%
==========================================
Files 110 110
Lines 7339 7339
Branches 1770 1770
==========================================
+ Hits 6018 6019 +1
+ Misses 1321 1320 -1
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
I'm not a fan of the main page (specifically, the list of all files in the project), but otherwise, looks good 👍🏻 |
|
Yeah, I was looking for an option to remove that big list. |
|
The theme author is looking into why the file list is there, it's not intentional. |
|
The file list is gone. I've added a script to update the jsdoc config file so it invludes the current version number in the link bakc to github, since this tempalte doesn't otherwise display the number. |
) * docs: Update jsdoc template for better use on mobile * add logo * add logo css * redirects should have trailing slash to avoid another redirect * add and style linnks in header, remove from footer * update theme to get rid of file list * improve doc index text * Add version number in Github link
The current jsodc template isn't very usable on mobile, and scores poorly in Lighthouse/Google Search Console in particular because of the small text. The TUI theme is unmaintained, so I've switched to https://github.com/ankitskvmdam/clean-jsdoc-theme which is a more responsive/accessible.
Removed guides as they live on videojs.com now.
To do:
Preview: https://deploy-preview-8048--videojs-docs.netlify.app/