linkedin/school-of-sre

Add Option for Printing Entire Webpage to PDF using mkdocs-print-site-plugin

Prajwalprakash3722 opened this issue · 7 comments

I would like to propose the addition of a feature that allows users to print the entire webpage as a PDF. This can be achieved by integrating the mkdocs-print-site-plugin into the repository. This plugin provides an option to generate a PDF version of the documentation, which would make it easy for users to print or save the content for offline reference.

Sounds good, would you be open to making a PR for this?

Yes I will submit a PR shortly

is there any reason why we have not tried to update the mkdocs version? @sumeshpremraj, asking this because mkdocs-print-site-plugin is trying to update the mkdocs to latest version by default.

No reason to not update.
But let's do the mkdocs upgrade in a separate PR, to keep things isolated and so that you can revert the upgrade alone in case of any issues.

Thanks for your suggestion. I agree with the idea of keeping things separate for better management. I'll follow your advice and perform the Markdown documentation (MkDocs) upgrade in a separate pull request. This way, we can handle any issues more effectively and maintain a clear history of changes.

Question: should we update mkdocs to the latest version?

Sure, you can use the latest version. You can test it locally, verify that pages render correctly and then open a PR.

Why not just use the print command (crtl+P) and save it to PDF?