Documentation: Add cheat sheet or reference card.
Closed this issue · 8 comments
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.
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.
Something like this:
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.
Any update on this?
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.
This is ok, thanks for (at least) considerimg this.
Cheers =)
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.