search

jupyter-book / mystmd

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

Some links (top nav, favicon, etc) don't use `BASE_URL` and are broken #1449

Open lwasser opened 1 month ago

lwasser commented 1 month ago

If you go to our pyOpenSci metrics dashboard you can see that the top level navigation doesn't seem to register the base_url repo name which is the "folder" or path required to resolve the metrics dashboard -- pyopensci.org/peer-review-metrics. However the side bar on the right does resolve the base_url properly.

You can see the github action that we are using here if you wish to test the action or see the action logs.

Description

Proposed solution

Ideally the base_url should register properly for every drop down link and base link in the top nav in addition to the toctree.

Additional notes

we discussed this in discord with @agoose77 and @choldgraf and it was determined to be a bug. please let me know if you want me to test anything!!

lwasser commented 1 month ago

Update - i just had a look at the raw html for our online metrics - it's not capturing the base_url for other elements too such as the favicon - (i think). the favicon for our site is in the images directory - i could move it to the root dir as well but it should be peer-review-metrics/favicon.ico (i think?)

<link rel="icon" href="/favicon.ico">

rowanc1 commented 3 weeks ago

Partial fix in #1483 - the favicon was written as text not binary in the static builds. We also need to update the BASE_URL as you suggest.

lwasser commented 3 weeks ago

Thanks, @rowanc1. I'll l switch our build to install from github to test things out in the next few days.

rowanc1 commented 2 weeks ago

It is released. I don't think it will work yet!

lwasser commented 2 weeks ago

Thank you!! I somehow thought it was fixed. I'll keep an eye on this. I realized it's not as simple as I thought to install mystmd from GitHub.