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

Need a better jsdoc theme #84

Open
KilledByAPixel opened this issue Jul 10, 2024 · 2 comments
Open

Need a better jsdoc theme #84

KilledByAPixel opened this issue Jul 10, 2024 · 2 comments

Comments

@KilledByAPixel
Copy link
Owner

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

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

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.

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