Opening PDF in a browser with Github Pages

57.3k views Asked by At

I am using GitHub Pages to host my website. I have a PDF file that I want visitors to be able to open directly in a browser. But when I upload the PDF file to GitHub Pages and link to it it opens in GitHub's viewer. Is there any way to open the PDF in a browser? I do not want to upload the document to dropbox or Google Drive as these services are not available in certain countries.

Using a raw URL would lead to download. But I would like to have the file open in the browser.

11

There are 11 answers

1
Chris On

Instead of loading your PDF directly from GitHub, include it in your GitHub Pages branch as a static file. This can be done by simply putting the file somewhere in your source tree:

Every other directory and file except for those listed above—such as css and images folders, favicon.ico files, and so forth—will be copied verbatim to the generated site. There are plenty of sites already using Jekyll if you’re curious to see how they’re laid out.

So put the PDF somewhere that makes sense, for example in pdfs/foo.pdf.

To make a link to this PDF work both locally and on GitHub Pages, Jekyll recommends the following (note especially point #2):

Sometimes it’s nice to preview your Jekyll site before you push your gh-pages branch to GitHub. However, the subdirectory-like URL structure GitHub uses for Project Pages complicates the proper resolution of URLs. Here is an approach to utilizing the GitHub Project Page URL structure (username.github.io/project-name/) whilst maintaining the ability to preview your Jekyll site locally.

  1. In _config.yml, set the baseurl option to /project-name – note the leading slash and the absence of a trailing slash.

  2. When referencing JS or CSS files, do it like this: {{ site.baseurl }}/path/to/css.css – note the slash immediately following the variable (just before “path”).

  3. When doing permalinks or internal links, do it like this: {{ site.baseurl }}{{ post.url }} – note that there is no slash between the two variables.

  4. Finally, if you’d like to preview your site before committing/deploying using jekyll serve, be sure to pass an empty string to the --baseurl option, so that you can view everything at localhost:4000 normally (without /project-name at the beginning): jekyll serve --baseurl ''

So now you can link to your PDF with {{ site.baseurl }}/pdfs/foo.pdf.

0
Mondli Buthelezi On

I have gone through most of the answers in this section however most of them are hard to figure out or too vague to understand what is happening. There is a simpler way to do this, so in order to display a Pdf file in a browser from Github here is the process:

Step 1: Make the static website/repository using your Github username for example, if the username is winterishere then repository would be winterishere.github.io

Step 2: Put the desired pdf in that repository and add an index.html file in the same location as the pdf file eg: resume.pdf.

Step 3: Open the index.html and add the embed tag to it below:

<embed src="https://yourusername.github.io/filename.pdf" width="100%" height="850px"/>

in my example the file the code would be:

 <embed src="https://winterishere.github.io/resume.pdf" width="100%" height="850px"/>
0
CKM On

My solution:

  1. put the file in https://my.github.io/files/paper.pdf
  2. add link <a href="https://my.github.io/files/paper.pdf">mypdf</a>
  3. push the changes.

Now if you click the mypdf link, it should open in browser directly.

0
Soroush Faridan On

Use Google Docs viewer with a URL like:

https://docs.google.com/viewer?url={link_to_pdf}

e.g.

https://docs.google.com/viewer?url=https://username.github.io/folder/document.pdf
5
Suman Bogati On

It's very easy to display Pdf in browser from Github static page, for that you need approach following process,

  1. Make the static website/repository using your Github username, for example, if the username is sumanbogati then repository would be sumanbogati.github.io
  2. Put the desired pdf in that repository
  3. Now locate the Url of Pdf wherever you want

For example, to display pdf in Html web page

<embed src="https://sumanbogati.github.io/sample.pdf" type="application/pdf" />

This is an instant demo.

0
Jarnail Singh On

Please feel free to try the below method as it worked for me on my Github pages.

We need two files:
a)Resume.html
b)Resume.pdf

Put these two files in the primary working directory. These files must be in the same directory as your "index.html" file.

Add the following to the HTML file you are working in (let's say its index.html):

   <li><a href="./Resume.html" target="_blank">
   <p>resume</p>
   </a></li>

Then, add the following to the resume.html you just created:

 <embed src="./Resume.pdf" type="application/pdf" width=100% height=850px />

What it'll do: After the primary HTML (i.e. index.html) is loaded and you click the resume text present in it, a new window should open and load resume.html, and this resume.html will load Resume.pdf.

0
Shippable.ls On

Place the PDF file in a folder like; www.website/pdf/example.pdf this will stop the file downloading outside of the root directory.

The steps are:

1. Create a new file in main directory.

2. Name file /pdf/ and save it.

3. Upload example.pdf file to this folder

Result:: PDF is viewable at; www.website/pdf/example.pdf

4. Optional step to avoid the .pdf URL. Create a index.html file in this folder and create a blank html file with PDF embed tag:

5
ruifgmonteiro On

Suppose your personal website is hosted in a Github page as follows:

https://username.github.io

The repository should be name as username.github.io. If you have a pdf file named document.pdf and you place it in the directory folder then you should be able to open it directly in the browser through the following link:

https://username.github.io/folder/document.pdf

To allow the user to open the pdf in a new window in the browser, you may use the following HTML, where "PDF" points to the link:

<a href="username.github.io/folder/document.pdf" target="_blank">PDF.</a>
1
richard937 On

Inside the index.html use this
<embed src="/Repo_Name/Resume_Name.pdf" width="100%" height="745px" />

This worked for me, check
** Only good for Laptop view

0
milliemince On

Make an file called index.html in your repository with only the following code in it:

<iframe src="./yourfile.pdf" width="100% height=100%">
</iframe>

Your pdf file needs to be in the same directory as your "index.html" file. This means that both your pdf file and index.html file need to be uploaded to your git hub repository. Then you can use github pages pointed to your "index.html" file to display the pdf in a browser.

Using the <iframe> tag is better now because the <embed> tag is no longer supported in some browsers/devices.

0
Jun On

You can link it this way

<a target='_blank' href={require('path/to/pdf/file')}>PDF Doc</a>

Then, when you push to GitHub page, you will see your pdf file path as so

https://userName.github.io/repoName/static/media/pdfFileName.hashNumber.pdf

I believe it works if you import the file instead of using require as well but I haven't tested with that.