search

Mugen87 / yuka

JavaScript library for developing Game AI.
https://mugen87.github.io/yuka/
MIT License
1.1k stars 90 forks source link

Documentation: Add cheat sheet or reference card. #40

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?

Thanks in advance for any help.

Mugen87 commented 3 years ago

is it there any PDF or single page document

Do you mind explaining in more detail how the output would look like? A screenshot of something similar would also be helpful.

I should mentioned that the layout of the documentation is messed up if you try to print a page. There is no support for that and I doubt it makes sense to invest a lot of time in developing printer-optmized styles/CSS.

anonimo82 commented 3 years ago

Something like this: docs

Mugen87 commented 3 years ago

Okay, I see now. A cheat sheet or reference card like https://www.khronos.org/files/webgl/webgl-reference-card-1_0.pdf.

I'm afraid this is currently a bit out of scope since the entire documentation is generated based on JSDoc. Authoring a different documentation that needs additional manual efforts is not something I would support.

However, if somebody could manage to implement a node.js script that generates such a PDF based the JSDoc, I'm willing to add this to the repository.

anonimo82 commented 2 years ago

Any update on this?

Mugen87 commented 2 years ago

No sorry. I've thought about this feature requests multiple time but I'm afraid this won't be implemented since the maintenance effort for a separate documentation resource is just too high. You have to work with the existing documentation.

anonimo82 commented 2 years ago

This is ok, thanks for (at least) considerimg this. Cheers =)

anonimo82 commented 1 year ago

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

Here it is (for 30 days)

anonimo82 commented 1 year ago

@Mugen87 check here

anonimo82 commented 1 week ago

Sorry for necro posting, but please, I have a different use case now: can we have the whole documentation as pdf or single HTML, printer friendly page?

Thanks in advance for any help. Regards, have a nice day.

anonimo82 commented 1 week 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.