jupyter-book / mystmd

Command line tools for working with MyST Markdown.
https://mystmd.org/guide
MIT License
219 stars 64 forks source link

Adding a trailing slash to the deployment context of the GitHub Pages deployment Action #1667

Open anjackson opened 3 days ago

anjackson commented 3 days ago

Description

I'm deploying a site to GitHub Pages as per the instructions. Once deployed under a context path (i.e. not at the server root), relative links that worked in local development (like this one) no longer work. This seems to be because the BASE_URL is not configured correctly.

Proposed solution

Currently the provided settings look like this:

/${{ github.event.repository.name }}

But for relative links to work, it needs a trailing slash:

/${{ github.event.repository.name }}/

Additional notes

❯ myst -v
v1.3.18