Export docs to PDF

[iozcelik]

What version of starlight are you using?

0.10.2

What is your idea?

After writing documentation, sometimes we need to export it as pdf. So, an export future will be good.

Why is this feature necessary?

It will be use for offline documentation.

Do you have examples of this feature in other projects?

-DocFx
-docusaurus-prince-pdf

Participation

• I am willing to submit a pull request for this issue.

[delucis]

This sounds really cool! I'm not sure whether this is something we'll be able to support as a core part of Starlight, but could be a good opportunity for a community tool? (Similar to the Docusaurus example you shared which is not part of the main Docusaurus project.)

[codingluke]

Hey there. I just wanted to point to https://github.com/jean-humann/docs-to-pdf which is actually a generic solution to paginate through a docs page, following a "next" link. It is a hard fork from mr-pdf. Here an example on how to integrate in a ci pipeline, and the result. There is still a very important feature missing to generate an outline.

Also the vitepress guys seem also to do great things in this direction. https://github.com/condorheroblog/html-export-pdf-cli/

Would be great to see synergy instead of parallel development 🚀

[adam4nj]

Have you tried using md-to-pdf.fly.dev

[kemo-1]

it uses pandoc so shouldn't we use pandoc insted?

[ailequal]

I ended up using simonhaenisch/md-to-pdf with this command md-to-pdf --basedir "$BASEDIR" ./file.md where BASEDIR is the root path of your starlight project. In this way any image that has been used will be included in the final PDF.

You can also add pagination and a title to the document and other things, check the project documentation.

In my case, I have written a bash script that automates some steps and I do quite like this solution in the end, even if not "native".

[kemo-1]

for me i decided to go the pwa route insted of turning the website into a pdf

[Linkerin]

Hello there. I recently stumbled upon the same need and built a tool for generating PDF from Starlight docs. It's not polished yet, nevertheless, it works as expected. Check it out: starlight-to-pdf.

[kemo-1]

Thank you so much!!!

[delucis]

Awesome stuff! 🌟