liabru / matter-js

a 2D rigid body physics engine for the web ▲● ■
MIT License
16.79k stars 1.96k forks source link

New API documentation generator? #1051

Closed onetrickwolf closed 2 years ago

onetrickwolf commented 3 years ago

Hey I was having a hard time navigating the Matter.js docs and played around with running it through webdoc with the PixiJS config. It actually worked with pretty little effort and it's so much easier for me to navigate I've actually been using it in my day to day.

Here's a screenshot:

image

Would Matter.js be interested at all in a contribution to migrate to webdoc? I think I could do it pretty easily and adjust the colors and style to match Matter.js branding more.

I noticed YUIDoc isn't really being maintained anymore as well so might be an added benefit switching in case that ever causes a problem.

liabru commented 3 years ago

Thanks for sharing. Every so often I look at alternative doc generators and figure none fit the project API style very well, or come with a nice theme out of the box. Though I've not seen this one before, so will check out when I'm back to docs.

To be fair YUIDoc supports most things I just need to work on the template. For now is there anything in particular you liked here most? I've been meaning to improve the sidebar navigation of the docs to include functions etc. would that help?

onetrickwolf commented 3 years ago

I've been meaning to improve the sidebar navigation of the docs to include functions etc. would that help?

Hey yeah that would be a huge help! I think what I really like from the PixiJS docs is the sub navigation that lists every method, property, event etc...

liabru commented 2 years ago

I've updated the docs for the latest release and included a new members navigation panel, hopefully that makes things a bit easier.

onetrickwolf commented 2 years ago

@liabru that's amazing thank you so much! Honestly was just coming here to see if I could help out a bit with your awesome project but thank you for taking the time to actually address this.