jackyzha0 / quartz

🌱 a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites
https://quartz.jzhao.xyz
MIT License
7.35k stars 2.54k forks source link

Github Action for Github Pages is generating a XML file #1530

Closed BiancaPereira closed 1 month ago

BiancaPereira commented 1 month ago

Describe the bug I'm trying to deploy the project using the Github action provided, but when the deploys finishes with no error, the page deployed has only a XML file (and not the static HTML file generated with styles)

To Reproduce Steps to reproduce the behavior:

  1. Fork the original template repo
  2. Add the deploy.yml file (https://quartz.jzhao.xyz/hosting#github-pages)
  3. Configure the Github Pages to use the action
  4. After the deploy is completed, a github page with a XML is generated

Expected behavior I expected to see a page like this to be generated: https://quartz.jzhao.xyz/

Screenshots and Source My repo: https://github.com/BiancaPereira/garden The XML generated: https://biancapereira.github.io/garden/

Desktop (please complete the following information):

Additional context I noticed from other users that the generated site is on their <user>.github.io URL, without the repo name at the end. I don't know if this is related

BiancaPereira commented 1 month ago

I was missing the index.md file in the root of my content folder.

It would be good to add it to the documentation! Or even add this in the bootstrap of the project.