So I tried to setup a resume page for myself using this guide.
Repository is https://github.com/AtlasFontaine/AtlasFontaine.github.io and my custom domain is https://emirhanavci.me/
Now, I did everything according to the guide. Added homepage key to package.json and added CNAME to the root of the repository. But initially when I went to emirhanavci.me it displayed the README.md from master branch. So a quick search led me to this post. According to that post, I needed an index.html file in the root of my master branch. So I copied the index.html in the /public directory and pasted it to /. Now it only returns a blank page when I visit my domain. Also when I look at the original repository of the creator of this guide, I see that he doesn't have an index.html in his root anyway.
Since then I removed index.html and now I'm back to the beginning.
Where did I go wrong?
So I copied the index.html in the /public directory and pasted it to /.
Your index.html must be in the project root folder (not in a subfolder like public/).
Basically, the document root folder is / and until your index.html is not moved there it will show the readme.md instead.
The problem with the browser response beeing blank is,
you are using node to run your project on localhost, but Github does not run node, instead, it is showing static (html) files.