Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How can I use a pdf file as the readme in my github repo?

I have a pdf file generated by latex which has many equations and what not. I want to use this pdf as the readme.md file in my github repo. How can I do this?

Alternatively, is it possible to directly integrate the tex file in github and use that as a readme instead of the pdf version? Does github allow any integration with latex syntax as does gmail for example?

like image 669
JRun Avatar asked Jun 15 '16 04:06

JRun


People also ask

How do I read a PDF in github ReadMe?

Currently there is no way to preview a pdf in github markdown, however you can embed an image of the pdf. From here: The best you can do is a greasemonkey extension which would allow you to call a pdf viewer, like the recent pdf.

Can ReadMe be PDF?

What Kinds of Rad Things Can You Do Using ReadMe With This New PDF Feature? You can write your docs as code, and generate PDFs (which documentarians will love)! You can maintain multiple versions of your docs as PDFs!

How do I add a PDF to a github repository?

On GitHub.com, navigate to the main page of the repository. Above the list of files, using the Add file drop-down, click Upload files. Drag and drop the file or folder you'd like to upload to your repository onto the file tree.

Can github host PDF files?

Upload Files to Github Github will accept any file as long as the size is within the 25 MB limit. Github has a built-in previewer for PDF, text and image files (including animated GIFs) so anyone can view them without downloading the actual file.


1 Answers

You cannot import PDF as Readme, but I also don't see the point as it support the wonderful MD Language which can be seen easily with any device (also mobile).

I have fixed the equations problem by using images. There is a nice website for that: http://mathurl.com/

Just type your latex equation and click "Make Math url" (bottom left button), the copy paste the image link (in red).

I have used it in the wiki of github (but it should work the same with readme.md): https://github.com/scholi/pySPM/wiki/Mass-calibration

Enjoy!

like image 187
scholi Avatar answered Sep 23 '22 14:09

scholi