Documentation looks beautiful locally but unstyled when deployed on GH pages

[gtauzin]

Hi,
I am trying to deploy documentation for a public repos with materials for mkdocs (and hopefully mike soon). I have a setup with some customization that looks good when build locally (or served). However, once I publish it to gh-pages (see action), what I see is simply a very raw unstyled html site.

Note that I set my pages on gh-pages branch and /docs repository. I have tried to use /root but then my site is basically an html verison of my README.md file. mkdocs creates a /site directory. How do I get it to be the one published?

From the action job itself, it seems like everything is happening as it should:

Run uv run mkdocs gh-deploy --force # TODO: Use mike to deploy versioned docs
Using CPython 3.10.12 interpreter at: /usr/bin/python3
Creating virtual environment at: .venv
Installed 139 packages in 408ms
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/runner/work/kedro-dagster/kedro-dagster/site
INFO    -  Documentation built in 0.28 seconds
WARNING -  Version check skipped: No version specified in previous deployment.
INFO    -  Copying '/home/runner/work/kedro-dagster/kedro-dagster/site' to 'gh-pages' branch and pushing to GitHub.
To https://github.com/gtauzin/kedro-dagster
   6118dfb..4738f70  gh-pages -> gh-pages
INFO    -  Your documentation should shortly be available at: https://gtauzin.github.io/kedro-dagster/

If anyone has any idea about what is happening, this would be greatly appreciated. Thank you!

[kamilkrzyskow]

Hello @gtauzin,
your current website looks like it was created using Jekyll, so it seems you've selected the main branch with /docs directory as the source.
It should use the gh-pages branch and / root directory.

The workflow pushes changes to the gh-pages branch
Then GitHub per the configuration should detect changes and run another action, and in your case it run a Jekyll build:

• https://github.com/gtauzin/kedro-dagster/actions/workflows/pages/pages-build-deployment

[gtauzin]

Thank you, that makes sense!