Developer Programs

Learn

Docs

Troubleshooting

Troubleshooting
GitHub
GitHub
If you are having issues with jhDocs, try troubleshooting the issues by stepping through the info below.

When my site is deployed, I can see the content, but everything looks awful

The baseURL setting in your config.yaml file must include the fully qualified URL to your site, including a slash on the end.

If you don’t have this set up properly, your site won’t be able to access the CSS and JavaScript resources needed for the site to render or behave as expected.

This can be an easy step to forget if you’re temporarily deploying your site to a different location than normal, say for testing purposes. If you leave the baseURL setting at its typical value, it won’t be readable from the new location.

Why does my site have a strange URL in GitHub Pages?

You have to mark the GitHub Pages visibility setting to a value of “Public” in settings (Settings > Pages > GitHub Pages > GitHub Pages visibility) in order to get a site URL that matches your repo name.

Private sites in GitHub Pages get a generated name that has nothing to do with your repo name, which is typically not what you want.

Next topic: Support

Support options
Have questions on this topic?
Join the jhDocs team in Microsoft Teams to connect with the community.
See something in this page that needs to change?
Send us feedback on this page.

Did this page help you?

Last updated Mon Dec 29 2025