42

I'm trying to host my webpages into Github pages but for some reason it seems to only show my Readme file.

GitHub repo: https://github.com/InquisitiveDev2016/InquisitiveDev2016.github.io

Website:

https://inquisitivedev2016.github.io/

Rookie
  • 475
  • 1
  • 5
  • 9
  • I was having the same problem when I first created my index.html in the root of my project, and this answer helped me to realize I simply needed to wait a few minutes and try again: https://stackoverflow.com/a/53678354/2604813 – Marcus Feb 27 '20 at 21:30

12 Answers12

25

GitHub Pages is doing what it is designed to do: hosting the contents of that repository.

The root of the question asker's repository only contained a single file (README.md). So there isn't an easy way to navigate to the other pages, e.g. repo/website/webpage.html.

Consider moving your web content into the root of your repository and renaming your default page to index.md or index.html, depending what type of file it is. (By convention the default page of most websites is called index.html, and this is what GitHub Pages will show by default if it exists.)

treckstar
  • 1,030
  • 1
  • 10
  • 25
Chris
  • 112,704
  • 77
  • 249
  • 231
11

Github gives you multiple choices where it takes it sources from. By default its the root of the master branch, which will use the README.md in case there is no index.html.

But you can also switch to the docs/ folder in your repository settings. With that you can put the index.html under the docs/ folder.

See enter image description here

oae
  • 1,220
  • 1
  • 15
  • 20
5

In my case, I had to choose the branch gh-pages/root in Pages settings on GitHub.

amabeat_30
  • 143
  • 1
  • 8
  • 1
    It worked for me. By default, it was ```main/root``` but the react app was deployed to ```gh-pages/root``` which I did by ```npm i gh-pages``` and changing it to ```gh-pages/root``` in github pages settings updated the deployment. – dpthegrey Jun 26 '21 at 07:07
  • 1
    This answer is so underrated. You saved my day! – Bidisha Das Dec 01 '21 at 17:54
  • Very happy to read this, Bidisha! Glad I could help – amabeat_30 Dec 16 '21 at 12:55
5

I had a similar situation when deploying a static React app from create-react-app (so index.html was in /public instead of root) with gh-pages npm package.

I had to select a gh-pages as a branch and /docs as a folder at GitHub Project -> Settings -> Pages -> Folder/Branch dropdowns. It wasn't intuitive since I didn't have /docs anywhere in my project files, but I'm glad that it eventually worked!

lomboboo
  • 1,151
  • 1
  • 11
  • 25
Iryna
  • 51
  • 1
  • 2
4

Create an index.html in the root and insert the line

<meta http-equiv="Refresh" content="2; url=public/index.html">

Or so it worked for me with a Vue CLI project I had this trouble with.

bretonio
  • 49
  • 2
1

The simplest solution to overcome this is put the index.html file in the outermost folder along with the readme.md

ilaggy
  • 23
  • 3
1

Please change the HTML file to index.html. This simple thing had me struggling for 6 hours to find this. My HTML name before was base.html; this shows the read me file only. After changing to index.html the file opened without any problems.

andrbrue
  • 691
  • 6
  • 14
karthi
  • 11
  • 1
1

if you want to access to index.html, try to write https://your-github-deploy-address/index.html

so just add '/index.html' at the end of the address! (this is how I solved my case)

Mira Weller
  • 2,381
  • 20
  • 27
bonlim
  • 103
  • 7
0

The steps to resolve this issue is from best practice is to go the your project folder. You should change what ever you named your root or initial page to index.html as mentioned above. Then open your project in git bash on your system, perform your normal git steps like,

  • git add
  • git commit -m " change to index.html"
  • git push origin master {depending on what you named your root branch}

Then go to settings and there you go (wow wow) after one or two refresh, your site will be live

Thân LƯƠNG
  • 2,807
  • 2
  • 10
  • 20
Omoefe Ugboma
  • 1
  • 1
0

For me, the problem was the docs folder was moved to .gitignore automatically. You have to delete docs from .gitignore, commit and push.

Mislav Sagovac
  • 93
  • 1
  • 6
0

To summer up, if your repository does not have an Index.html it will show the ReadMe file. Thus in order to correct it all you need to do is add an index.html or index.md file to your folder and use that as main. From there all the others will be access through a link on this page. Similarly to a webpage.

Vinicius Raphael
  • 101
  • 2
  • 4
0

Change the GitHub Pages source to gh-pages with folder as /(root)

HarshitChopra
  • 41
  • 1
  • 3
  • I'd say this answer has been repeated multiple times already in this question, so it may be considered a duplicate. – treckstar May 28 '22 at 13:49
  • 1
    Please up-vote those answers/comments, as the accepted answer of this post is not correct/working – HarshitChopra May 28 '22 at 14:27
  • Yes I absolutely try and up vote as much as I can, was simply just making an observation. I would disagree that the accepted answer isn't correct, the concept still applies, just the link is no longer working. I did put in an edit to remove that broken link as well. – treckstar May 28 '22 at 16:23