system-design-primer icon indicating copy to clipboard operation
system-design-primer copied to clipboard

Published 20 hours ago • verified publisher icon donnemartin

GithubPages deployment?

Open mayrmartin opened this issue 2 years ago • 3 comments

It would be great to have access to this guide in a structured, well-formatted & searchable manner. I've seen there is an open issue regarding the automated PDF generation in the GitHub Actions but as far as I can see, there the output is neither really well-formatted nor really good searchable.

A possible solution would be to automatically generate a static webpage using Docosaurus from existing .md files inside GitHub Actions & deploy the page via GitHub Pages. To make the whole content searchable there are available plugins such as https://www.npmjs.com/package/docusaurus-lunr-search or even Algolia. There is also a possibility to automatically add a PDF download via mr-pdf.

mayrmartin avatar May 03 '22 07:05 mayrmartin

@mayrmartin Can you share about the PDF not being searchable enough? The PDF generated here should support full searching. If there is missing functionality, I would like to see if I can tweak the automation to make it more suitable.

rcalixte avatar Jul 30 '22 17:07 rcalixte

The PDF you mentioned is indeed searchable but the PR which implements the autogeneration (PR #632) is still open. It would be great if this generation step could be merged in order to have a PDF which is always up-to-date

mayrmartin avatar Jul 30 '22 19:07 mayrmartin

Agreed. It's a hefty PR so we're waiting until @donnemartin has time to review it. Thank you for the feedback though! I've been rebasing, regenerating, and re-uploading the PDF when possible until the PR is merged so you can get a fairly updated copy should anything else be merged in the repo before then. Cheers!

rcalixte avatar Jul 30 '22 20:07 rcalixte