Compodoc: [FEATURE] PDF Export support

[carlobonamico]

Overview of the issue

In many context there are requests for also producing PDF documentation. Currenlty, compodoc only generates html documentation.

This could be implemented with three levels of integration:
1) adding some javascript code to integrate with tools such as https://github.com/melix/deck2pdf or https://wkhtmltopdf.org/
2) generating a single html page which then can be feed to https://wkhtmltopdf.org/ or headless chrome for conversion
3) direct PDF export from the compodoc generation

Operating System, Node.js, npm, compodoc version(s)

n/a for now, to be refined

Compodoc installed globally or locally ?

n/a

Motivation for or Use Case

Support for printing the documentation, or distributing it offline to an ebook reader

Reproduce the error

n/a

Related issues

n/a

Suggest a Fix

n/a

[vogloblinsky]

Hi,
Yes it could be a cool feature.
After some researches on npm, the strategy could be to specify the output type --pdf, rendering in memory all the html, and generate the main pdf at the end.

[carlobonamico]

Tools such as headless chrome
https://developers.google.com/web/updates/2017/04/headless-chrome#create_a_pdf_dom

And phantom Js
http://phantomjs.org/screen-capture.html

Already support PDF generation from a single html page.

Maybe a first step could be that of supporting the generation of the
documentation in a single HTML file, which can then be converted to PDF
more easily.

On Jun 8, 2017 3:56 AM, "Vincent Ogloblinsky" [e-mail]
wrote:

Hi,
Yes it could be a cool feature.
After some researches on npm, the strategy could be to specify the output
type --pdf, rendering in memory all the html, and generate the main pdf at
the end.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/compodoc/compodoc/issues/190#issuecomment-306975848,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAdBqQDYmbPL5aspmITo19bZ7c5hfB_sks5sB1TTgaJpZM4Nrdah
.

[vogloblinsky]

@carlobonamico
Yes, that will be the strategy. Build only one page during generation, and at the end launch such a tool, phantomjs for example to build the pdf.

[DrMabuse23]

Hi there iam also interested about this feature. I can help anywhere ? to get a little bit faster ?

[vogloblinsky]

@DrMabuse23
We are working on JSON export feature, PDF will follow just after that.
To be more independant of rigid solution like phantomjs or wkhtmltopdf, i think we will use libraries like pdfmake http://pdfmake.org/playground.html or pdfkit http://pdfkit.org/demo/browser.html
If you want to put the structure of the pdf, it could be fine.
I think i will list all the stuff, with a table of contents at the beggining.

[jdmichaud]

Is this feature still planned?

[vogloblinsky]

@jdmichaud Yes, work in progress on this feature branch : https://github.com/compodoc/compodoc/tree/feature/pdf-export

[hiteshkumar04]

Is there any export functionality provided with it?

[Sofiane000]

Any idea when will this be ready? Thanks

[sgarelle]

Any plan to implement this feature?

[vogloblinsky]

Just restarted the work. Coming soon.

[Sofiane000]

@vogloblinsky , any progress on this please ?
Thanks

[gtamas]

What's up with this? When can we expect this feature to be released?

[goseeya]

@vogloblinsky any update please?

[SWGeekPD]

Any update on this feature...

[jfernandz]

I'm also interested on updates about this feature :-)

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale[bot]]

This issue has been automatically closed because it has not had recent activity. Please file a new issue if you are encountering a similar or related problem. Thank you for your contributions.

[radarsu]

Any update on that?

[csasfr]

Updates ?

[haexyh]

huh?

[kenanaReda]

so it seems this feature hasn't been released yet?

[Botrap]

Any update on this?

[eddytnk]

Is this still a plan or not?

[vogloblinsky]

Yes, planned for 1.2.0

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale[bot]]

This issue has been automatically closed because it has not had recent activity. Please file a new issue if you are encountering a similar or related problem. Thank you for your contributions.

[ALapaque]

@vogloblinsky Hi there, do you have any news on this features and the release date of the 1.2.0 ?