GitHub pages only showing ReadMe file?

Question

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/

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

score 36 · Accepted Answer · edited May 29 '22 at 19:28

36

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.)

edited May 29 '22 at 19:28

treckstar

1,956
5
21
26

answered Feb 22 '18 at 04:07

ChrisGPT was on strike

127,765
105
273
257

3

In case it might help someone...I had to move all my build files including index.html to the root folder to get it working – Marvel Moe Feb 23 '21 at 21:43

score 19 · Answer 2 · answered Jul 15 '19 at 21:02

19

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

answered Jul 15 '19 at 21:02

oae

1,513
1
17
23

How do I add the index.html to the "docs" folder? I don't see it anywhere – rickandmorty Apr 13 '21 at 23:40
1

You usually checkout the project, add the file, commit and push! Checkout regular `git` https://git-scm.com/ – oae Apr 15 '21 at 06:25

score 11 · Answer 3 · answered May 24 '21 at 07:26

11

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

answered May 24 '21 at 07:26

fadingbeat

355
3
16

2

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
2

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 – fadingbeat Dec 16 '21 at 12:55
thanks this should be the accepted answer – سعيد Sep 01 '23 at 12:02

score 6 · Answer 4 · edited Oct 27 '21 at 16:38

6

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!

edited Oct 27 '21 at 16:38

lomboboo

1,221
1
12
27

answered Oct 27 '21 at 08:03

Iryna

61
1
3

This is quite helpful for me, thanks – Stephen Melben Corral May 24 '22 at 08:30

score 4 · Answer 5 · answered Aug 27 '19 at 16:17

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.

answered Aug 27 '19 at 16:17

bretonio

49
2

score 4 · Answer 6 · edited Apr 24 '22 at 08:44

4

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)

edited Apr 24 '22 at 08:44

Mira Weller

2,406
22
27

answered Feb 06 '21 at 06:28

bonlim

163
9

score 2 · Answer 7 · answered Jan 18 '23 at 08:44

For me, this solution solves the issue:https://github.com/gitname/react-gh-pages

Open the package.json file, add two properties as below:

Add a homepage property in this format*: https://{username}.github.io/{repo-name}

For a project site, that's the format. For a user site, the format is: https://{username}.github.io. You can read more about the homepage property in the "GitHub Pages" section of the create-react-app documentation.
```
  {
    "name": "my-app",
    "version": "0.1.0",
  + "homepage": "https://gitname.github.io/react-gh-pages",
    "private": true,
```

Add a predeploy property and a deploy property to the scripts object in :

  "scripts": {
  +   "predeploy": "npm run build",
  +   "deploy": "gh-pages -d build",
      "start": "react-scripts start",
      "build": "react-scripts build",

score 1 · Answer 8 · answered Sep 17 '20 at 10:43

1

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

answered Sep 17 '20 at 10:43

Deb

355
2
9

score 1 · Answer 9 · edited Oct 06 '20 at 12:11

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.

edited Oct 06 '20 at 12:11

andrbrue

721
6
15

answered Oct 05 '20 at 15:50

karthi

11
1

This is great but how do you get the index.html file to use themes? – Dave Oct 27 '21 at 18:26

score 0 · Answer 10 · edited Nov 21 '20 at 14:48

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

score 0 · Answer 11 · answered Jan 21 '21 at 14:34

0

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

answered Jan 21 '21 at 14:34

Mislav Sagovac

185
1
8

score 0 · Answer 12 · answered May 21 '22 at 15:06

0

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

answered May 21 '22 at 15:06

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

Shankar · Answer 13 · 2023-07-16T05:56:05.863

0

Github is looking into root folder and displaying readme.md file .Append SiteUrl given by github with the path to index.html file . so github pages start rendering your index.html file.

Where to get site Url

In my case my complete Url will be https://userName.github.io/RepoName/src/index.html

edited Jul 16 '23 at 05:56

answered Jul 16 '23 at 05:50

Shankar

1
1

score -1 · Answer 14 · answered Jul 06 '21 at 01:25

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.

GitHub pages only showing ReadMe file?

14 Answers14

Linked

Related