Skip to content

Add step to generate PDF artefact - #46

Draft
riteshakya037 wants to merge 3 commits into
masterfrom
improvement/generate-pdf
Draft

Add step to generate PDF artefact#46
riteshakya037 wants to merge 3 commits into
masterfrom
improvement/generate-pdf

Conversation

@riteshakya037

Copy link
Copy Markdown
Member

Changes

  • Add docusaurus-prince-pdf to generate PDF artefacts
  • Updated github workflow to include PDF generation step
  • Remove package-lock.json as we are using yarn
  • Update README to include PDF generation steps.

Sample output

rubix-ce.pdf

Additional Notes

  • Workflow changes need testing.

@riteshakya037
riteshakya037 requested review from NubeDev and RaiBnod June 19, 2024 09:47
@riteshakya037
riteshakya037 had a problem deploying to Deploy to GitHub Pages June 19, 2024 10:06 — with GitHub Actions Failure
@riteshakya037
riteshakya037 temporarily deployed to Deploy to GitHub Pages June 19, 2024 10:24 — with GitHub Actions Inactive
@riteshakya037
riteshakya037 had a problem deploying to Generate PDF from Deployed Site June 19, 2024 10:32 — with GitHub Actions Failure
@riteshakya037
riteshakya037 temporarily deployed to Deploy to GitHub Pages June 19, 2024 13:54 — with GitHub Actions Inactive
@riteshakya037
riteshakya037 force-pushed the improvement/generate-pdf branch 3 times, most recently from 38298fc to be20c50 Compare June 19, 2024 14:33
@riteshakya037
riteshakya037 force-pushed the improvement/generate-pdf branch from be20c50 to 7ec0513 Compare June 19, 2024 14:55
@riteshakya037

Copy link
Copy Markdown
Member Author

@RaiBnod Please reference this success report.

@riteshakya037
riteshakya037 marked this pull request as draft June 20, 2024 03:46
@riteshakya037

Copy link
Copy Markdown
Member Author

Marking this as a Draft because the Prince library used here may require a commercial license.

More details here

@riteshakya037

Copy link
Copy Markdown
Member Author

docusaurus-prince-pdf vs. docs-to-pdf

Prince creates visually appealing documents with excellent page navigation. However, it places a watermark on the first page of the generated PDF, which can be problematic. The high cost of the commercial license, at $3,800, is also a significant drawback.

On the other hand, docs-to-pdf is a free and open-source solution that integrates well with Docusaurus sites. However, docs-to-pdf struggles with rendering some components correctly, resulting in unusual shadows in places. Moreover, text in PDFs generated by docs-to-pdf cannot be copied or searched accurately because it's a Puppeteer-based build, and cross-links within the documentation also do not function properly.

I've attached a copy of the generated PDF by docs-to-pdf for your reference here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant