Hosting doc on github and large files

Stream: general

[Ian Jauslin]

Hi there! I am looking into having a blueprint for one of the projects that we are working on, and would like it to be hosted on github itself. I figured I would keep things simple, and just upload the documentation generated by doc-gen4 and the blueprint generated by Patrick Massot's plastex plugin to the github repository, and browse it using github Pages. The issue I have is that doc-gen4 generates some pretty big '.bmp' files, which would require git-lfs. Is there a simple way around this? Should I be doing things differently? Or should I just go ahead and use git-lfs?

[Yaël Dillies]

Yes. Basically, don't dump the files in the first place.

[Eric Wieser]

GitHub pages has two modes:

• Serve a website from the contents of a git repo
• Serve a website from the output of a build step that takes a git repo as input

The second one means the bmp file is never committed, which avoids the size issues

[Utensil Song]

The second option is what's used in the PFR project, and the same as the one I explained in another thread.

[Ian Jauslin]

Thank you! I didn't expect github would do all of this for free. I'm impressed! I'll set it up.