search

openlilylib / snippets

A place to store useful pieces of LilyPond code - custom functions, engravers, hacks, templates, examples etc.
Other
119 stars 39 forks source link

Include PDF examples where applicable for easy display on Github #148

Open msikma opened 8 years ago

msikma commented 8 years ago

Github now displays PDF files like any other image. PDF display isn't 100% perfect, but it's good enough—here's an example of one of my projects.

Especially for small snippets or examples it would be very nice to have PDF examples that can quickly demonstrate a concept. They can also be included into Markdown files.

The best way to store PDF files would be through Git LFS, to prevent them from slowing down the repository.

uliska commented 8 years ago

Thank you for these pointers, we'll surely consider them as they would improve user experience.

What seems feasible is a hook that automatically builds PDFs from the example files upon pushing. So anything that is present as example in the repo would automatically be displayed as PDF.