Github live previews readme instead of index.html in the /dist/ folder

Question

Context: working on a simple todo list app as part of the Odin Project. I'm on an assignment where we must assemble this project using webpack, but no other frameworks (just vanilla js).

What I expect to happen: my live preview shows up successfully when I push to main. I am trying to finish up the todo list app via webpack.

What happens instead: Instead of previewing my app, my github live preview only shows the readme file instead.

What I have tried: When I google the issue, most people who have had this problem say that it is because of either not having an index.html file at all (which I do) or suggest moving it to your root. But webpack puts the packaged file into /dist, and that worked just fine with my restaurant project, so I'm not sure what is wrong here. I have also tried to update the readme to link to the index.html as this user did in a similar question, only with permalink: ./dist/index.html, but doing this for my code just made the live preview 404 entirely.

Link to Repo: https://github.com/manski117/todo-list-app-project

Link to what is supposed to be the live preview: https://manski117.github.io/todo-list-app-project/

Answer 1

I see your build uses Jekyll.

It is better to use the official actions/starter-workflows pages/jekyll.yml action.

See Jekyll GitHub Action, and add it in .github/workflows, with the source of your site directly at the root folder. Including a _config.yml to set at least the title.

But if your webapp should not use Jekyll, then chose one of the others starter workflows, or adapt one to your own application.

---

See also "Configuring a publishing source for your GitHub Pages site"

You can directly publish a built content:

The source branch can be any branch in your repository, and the source folder can either be the root of the repository (/) on the source branch or a /docs folder on the source branch.

So no "dist".