Deploying to GitHub Pages via action succeeds but I get a 404 when I visit the actual site

[hrushikeshrv]

Hi, first off, thanks for this great theme and the work you do to maintain this repo!

I'm trying to host docs for an open source project I maintain using the just-the-docs theme. My repo is github.com/hrushikeshrv/mjxgui.

I'm trying to host my docs from the docs/ directory, so I've followed the steps mentioned here -

1. I've created a .github/workflows directory and copied the pages.yml file into it
2. I've created a docs/ directory and copied all the other template files into it
3. I have an index.md file in docs/
4. I've modified the GitHub Actions workflow in the pages.yml file
5. I've configured to build and deploy the docs using GitHub actions in Settings > Pages section of my repo
6. I've edited the _config.yml file to contain my repo's URL

The pages build and deploy succeeds, but when I go to my pages URL, hrushikeshrv.github.io/mjxgui or, since I've set a custom domain for my GitHub account, hrus.in/mjxgui, I get a 404. What am I doing wrong?

[pdmosses]

Hi @hrushikeshrv, thanks for the kind words about the theme! You wrote:

3. I have an index.md file in docs/

[...]
The pages build and deploy succeeds, but when I go to my pages URL, hrushikeshrv.github.io/mjxgui or, since I've set a custom domain for my GitHub account, hrus.in/mjxgui, I get a 404. What am I doing wrong?

Jekyll has copied your index.md file to your site verbatim, instead of converting it to index.html. As mentioned on the theme docs home page:

Jekyll builds your site by converting all files that have front matter to HTML.

If you add front matter to the file, the HTML page should appear on your site.

[hrushikeshrv]

That worked, thanks!