Fix Zenodo badge on landing page#598
Conversation
for more information, see https://pre-commit.ci
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below. |
|
The badges look awkward in their current position, centered on the page and with line gaps between them. We want them to be discreetly lined up horizontally under the title, like on a GitHub readme page. There is some guidance in the MyST docs here for alignment of subfigures, which should help. |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
Since nothing I tried successfully got the badges to appear on the landing page without looking weird, I changed course here. The badges are gone. Instead I specified our Zenodo DOI (the "all versions" one) in myst.yml and just let MyST handle putting the DOI link on the landing page automatically. |
|
A couple side notes:
|
|
This PR also closes #553 for Foundations, although a broader issue affecting how we template Cookbooks still needs to be solved there I think. |
kafitzgerald
left a comment
There was a problem hiding this comment.
Bit of a bummer to lose the badges on the README, but I think this makes sense.
|
So to be clear, the badges are still on the README that gets displayed on GitHub. This PR just affects the landing page of the rendered book. Because of some differences in how the markdown is rendered by myst versus GitHub, keeping those two pages looking the same was difficult. |
My mistake. For some reason I had assumed the landing page and README were the same here (perhaps it is in cookbooks). Thanks for the clarification on that. |
That is indeed how it works in the Cookbook repos. Foundations has a separate README that isn't included in the rendered book. Recent versions of MyST seem to have changed how the badges are rendered, which is making lots of cookbook landing pages look a bit weird, e.g. here. I'll open a separate issue elsewhere to track that. |
Following #592, this PR fixes the Zenodo badge that is displayed on the book landing page (https://foundations.projectpythia.org)