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

pdf github latex readme
JRun picture JRun · Jun 15, 2016 · Viewed 23k times · Source

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?

Answer

scholi picture scholi · Jul 9, 2018

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!

Related questions

Effortless export from github wiki (?)

I am collecting quite a lot of material in a GitHub wiki. I really like to use the wiki to cooperate with other people and IMHO the platform is really nice, I like it! So, I would like to keep …

Read More
PDF to Github Flavored Markdown

I have a project description in PDF and I will be quite happy if I can somehow manage to preview it in github website rather than clicking "View Raw" and downloading it. I thought there could be a converter from …

Read More
Embed a PDF in github/gitlab wiki

I'm using gitlab to manage my repositories which has been quite pleasant so far. However the wiki could use a fair amount of improvement IMO. It's really annoying when you already have documentation that you simply want to add to …

Read More