Navigation including '.md' when using GitHub Pages

[LoganDavidTalbot]

Context

No response

Bug description

I have using the nav element in the mkdocs.yaml and its bring me directing to the wrong URL with the '.md' in it link only when deploying to GItHub pages. If I run it locally it works fine.

For example locally when clicking "onboarding a user" it links to http://127.0.0.1:8000/Getting-Started/onboarding-a-user/, which is great!

But then deploying to GitHub pages it deploys and clicking "onboarding a user" it links to "https://defra.github.io/adp-documentation/Getting-Started/onboarding-a-user.md" which is not correct and give back the result in this screenshot:

If I remove '.md' from the URL it will show the page I what (https://defra.github.io/adp-documentation/Getting-Started/onboarding-a-user).

This is a interesting bug to encounter please help in providing a fix or a work around.

Related links

• Reporting a bug
• source coe
• mkdocs.yaml

Reproduction

Provided source code link: link

Steps to reproduce

Provided source code link: link
READ.ME instructions

Browser

Chrome

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction.

[LoganDavidTalbot]

Anyone got any advice to sort this its a very weird issue to have?

[kamilkrzyskow]

For now try with POSIX paths, aka use / instead of \ to separate the directories and files. GitHub Actions run on Linux.
Tough, I would assume that converting from Windows to POSIX paths should be handled via MkDocs, so perhaps I'm missing something 🤔
Apart of that in Linux (therefore also in browser URLs) paths are case-sensitive, so I recommend using only lowercase.
Tough be aware that it will break the current links Getting Started etc. in your browser's history, since they use mixed case.
EDIT: I don't mean only the mkdocs.yml but also the actual files/directory names

https://github.com/DEFRA/adp-documentation/blob/9abb6ca8400d72be73239b016adb8d667d58cb38/mkdocs.yml#L73-L88

[LoganDavidTalbot]

Your a star thankyou very much this sort it.

[kamilkrzyskow]

Sure thing, also just now I got the idea to check the logs, and they point to the same thing I mentioned. Also some other warnings got revealed: https://github.com/DEFRA/adp-documentation/actions/runs/7965431606/job/21744931467#step:6:26