search

liabru / matter-js

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

Printable documentation #998

Closed anonimo82 closed 2 years ago

anonimo82 commented 3 years ago

Hello everyone. I'd like to print the whole class reference for this, is it there any PDF or single page document?

Something like this: docs

Thanks in advance for any help.

liabru commented 3 years ago

Unfortunately at the moment there's no 'cheat sheet' format like this for the docs, but it's a neat idea and I will keep it in mind when improving the docs in future.

Maybe there are some tools that can help you generate this though?

anonimo82 commented 3 years ago

I don't know, but maybe?

anonimo82 commented 2 years ago

Any update on this?

liabru commented 2 years ago

This isn't something I'm working on at the moment but the docs have been improved to make it easier to see an overview of all module members at once e.g. on Matter.Engine.

anonimo82 commented 2 years ago

Ok, thanks so much. Looking forward this =)

Edit: No, sorry, I misinterpreted you. Do you have something like an idl?

liabru commented 2 years ago

@anonimo82 not sure what you mean by idl?

anonimo82 commented 2 years ago

Nothing, I messed up with terms from other projects, but an IDL is something you would use (in eg) with emscripten

anonimo82 commented 2 years ago

I did one myself, it's quite big, but maybe someone will summarise it (?) I just pasted each documentation page in turn inside a PDF document, nothing special.

Here it is (for 30 days)

anonimo82 commented 2 years ago

@liabru please, check back here

anonimo82 commented 2 months ago

I'm back asking for printable documentation, but I'm not looking for cheatsheets this time. Please, can you provide the whole documentation as a pdf or as a single, printer friendly page?

photonstorm commented 2 months ago

Why not just do this yourself? It feels like a complete waste of the developers time to request here. There are far more important things to be done with the library.

anonimo82 commented 2 months ago

Because I have no idea how to. Is it there a way I can "procedurally"? Edit: Ok, npm run doc. But gives this error:

> matter-js@0.20.0 doc
> yuidoc --config yuidoc.json --project-version $npm_package_version

sh: riga 1: yuidoc: comando non trovato

Edit: Nevermind, installed the yuidoc package and now it works.

anonimo82 commented 2 months ago

Nevermind, I generated the documentation in HTML, then converted each HTML file in PDF with pandoc for i in *.html; do pandoc -f html -t pdf -o $i.pdf $i; done then joined the PDFs with another package called pdfarranger.

All with Linux, IDK how would I've been done with Windows.... Of course a solution would exist, but IDK it. If is anyone interested, I can send the final PDF.

Thanks everyone anyhow.