search

KilledByAPixel / LittleJS

LittleJS is a fast HTML5 game engine with many features and no dependencies. 🚂 Choo-Choo!
MIT License
3.19k stars 160 forks source link

Need a better jsdoc theme #84

Open KilledByAPixel opened 2 months ago

KilledByAPixel commented 2 months ago

The formatting on this jsdoc theme is very difficult to read.

https://killedbyapixel.github.io/LittleJS/docs/

Here is just one example of how it is confusing.

image

thewrath commented 2 months ago

Hi 🚂,

I took a look at the themes available for JSDoc and I can't find anything good except the one already in place ^^ the themes are either “obsolete” or not well formatted.

I think the best way would be to evolve the theme in place on the parts that are not great. What do you think?

Also, I think it would be interesting to integrate documentation generation into the build process.

KilledByAPixel commented 2 months ago

Thanks for checking! I came to the same conclusion, just a sad state of plugins.

For now I am just waiting a bit to see of a new better one comes out but we may need to do it ourselves.

I would like to integrate the doc gen to the build process soon, right now i have that in a separate folder on my local pc, but it is all automated and could be put up on github.