5 ms·

I searched the documentation for "pdf" and did not find anything relevant - is it really true that this is not able to generate a PDF from the written text? Ge

I searched the documentation for "pdf" and did not find anything relevant - is it really true that this is not able to generate a PDF from the written text? Generating a proper PDF document still seems a very basic requirement for anything that produces documentation. I am sure I am missing something?

deleted 4y ago
[deleted]
mooreds 4y ago
https://www.npmjs.com/package/docusaurus-pdf https://www.npmjs.com/package/docusaurus-pdf looks useful. Unclear which version this supports, however. (Not a user of docusaurous, YMMV).
- POPOSYS 4y ago
  Sorry, but did you look at the example document? Could you really provide such a result to some serious documentation project? I guess not.
  - mooreds 4y ago
    I did not do more than google a bit and share the link.
TobbenTM 4y ago
If you hit the print button, the print layout is pretty good, pretty much ready to print to PDF if you ask me!
- POPOSYS 4y ago
  I do not see any print button - dou you mean web browser print "button"? I did that - the resulting pdf can not be presented as documentation. It is not satisfying even the most moderate requirements for a documentation pdf. Generating only a website for documentation seems like a cultural step back.
  - slorber 4y ago
    We do not have a first-class plugin to generate a linear PDF documentation, but are willing to have one. Our plugin lifecycles could enable you to build one, and we might create an official one in the future. Keep in mind Docusaurus is a good tool to produce interactive docs. A PDF is not very interactive so if you want any interactivity, you'd have to limit yourself to a subset of Docusaurus features. > Generating only a website for documentation seems like a cultural step back. No it's actually the trend to have more interactivity. A linear PDF is more like old-school. Don't you like that on the Stripe docs there's a built-in API client? How are we supposed to render this Docusaurus page on a PDF exactly? https://www.courier.com/docs/reference/send/message/ https://www.courier.com/docs/reference/send/message/ Supporting PDFs remains useful but it's more an edge case than the main feature of Docusaurus. We have some users willing to edit books using Docusaurus, but most users do want interactivity, and it's definitively a step forward.
jug 4y ago
It's a website generator.
- eevilspock 4y ago
  Websites often have PDF versions of a page for download / offline viewing.
akarlsten 4y ago
I don't know if this is just performative boomerism on your part, but I don't see how generating a PDF is a "very basic requirement" in 2022. What are you going to do, print it?
- badsectoracula 4y ago
  Print it, read it in an (e-ink) ebook reader or whatever. Many people do not feel comfortable reading from a monitor screen. Also book-like PDFs tend to focus on the content instead of the surrounding chrome like navigator menus or whatever, so they can be used like that too (though an epub would probably be better for that - and the ebook reader too).
  - slorber 4y ago
    Docusaurus wants to make the docs interactive to produce a great reading experience. How can we provide that and yet print on PDF? Remember Docusaurus input remains markdown files so you can still look for another tool that is able to generate a PDF from the same folder of existing markdown files. We'll likely support producing a PDF but it's not the main value proposition of Docusaurus, just a nice to have for those that really want a linear static PDF instead of a beautiful and interactive doc site.

deleted 4y ago

[deleted]

mooreds 4y ago

https://www.npmjs.com/package/docusaurus-pdf https://www.npmjs.com/package/docusaurus-pdf looks useful. Unclear which version this supports, however. (Not a user of docusaurous, YMMV).

POPOSYS 4y ago
Sorry, but did you look at the example document? Could you really provide such a result to some serious documentation project? I guess not.
- mooreds 4y ago
  I did not do more than google a bit and share the link.

TobbenTM 4y ago

If you hit the print button, the print layout is pretty good, pretty much ready to print to PDF if you ask me!

POPOSYS 4y ago
I do not see any print button - dou you mean web browser print "button"? I did that - the resulting pdf can not be presented as documentation. It is not satisfying even the most moderate requirements for a documentation pdf. Generating only a website for documentation seems like a cultural step back.
- slorber 4y ago
  We do not have a first-class plugin to generate a linear PDF documentation, but are willing to have one. Our plugin lifecycles could enable you to build one, and we might create an official one in the future. Keep in mind Docusaurus is a good tool to produce interactive docs. A PDF is not very interactive so if you want any interactivity, you'd have to limit yourself to a subset of Docusaurus features. > Generating only a website for documentation seems like a cultural step back. No it's actually the trend to have more interactivity. A linear PDF is more like old-school. Don't you like that on the Stripe docs there's a built-in API client? How are we supposed to render this Docusaurus page on a PDF exactly? https://www.courier.com/docs/reference/send/message/ https://www.courier.com/docs/reference/send/message/ Supporting PDFs remains useful but it's more an edge case than the main feature of Docusaurus. We have some users willing to edit books using Docusaurus, but most users do want interactivity, and it's definitively a step forward.

jug 4y ago

It's a website generator.

eevilspock 4y ago
Websites often have PDF versions of a page for download / offline viewing.

akarlsten 4y ago

I don't know if this is just performative boomerism on your part, but I don't see how generating a PDF is a "very basic requirement" in 2022. What are you going to do, print it?

badsectoracula 4y ago
Print it, read it in an (e-ink) ebook reader or whatever. Many people do not feel comfortable reading from a monitor screen. Also book-like PDFs tend to focus on the content instead of the surrounding chrome like navigator menus or whatever, so they can be used like that too (though an epub would probably be better for that - and the ebook reader too).
- slorber 4y ago
  Docusaurus wants to make the docs interactive to produce a great reading experience. How can we provide that and yet print on PDF? Remember Docusaurus input remains markdown files so you can still look for another tool that is able to generate a PDF from the same folder of existing markdown files. We'll likely support producing a PDF but it's not the main value proposition of Docusaurus, just a nice to have for those that really want a linear static PDF instead of a beautiful and interactive doc site.