Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't tweak src URL of img links, if absolute #1955

Merged
merged 3 commits into from
Jan 6, 2022
Merged

Conversation

jennybc
Copy link
Member

@jennybc jennybc commented Dec 5, 2021

vroom sources taylor.gif from a raw GitHub link in README / index.html. The gif used to live in gh-pages, but that's not compatible with clean = TRUE in deploy_to_branch(), i.e. it keeps going missing.

I tried relocating the gif to man/figures and vignettes, but the link remained broken in the rendered site. I then realized that the link was being tweaked by pkgdown to a nonexistent path, when transforming README.md into index.html.

Based on the comment above tweak_img_src() (# Fix relative image links), I'm pretty sure this PR is compatible with the original intent.

jennybc added a commit to tidyverse/vroom that referenced this pull request Dec 5, 2021
I think I figured out why the previous locations weren't working:
r-lib/pkgdown#1955
@juniperlsimonis
Copy link

thank you so much for tracking this down, @jennybc
just caught this problem in some packages' pkgdown pages and had not been able to figure out what the heck is up

@hadley
Copy link
Member

hadley commented Jan 6, 2022

Would you mind adding a news bullet please?

@hadley hadley added this to the v2.0.2 milestone Jan 6, 2022
@hadley hadley merged commit b746af1 into main Jan 6, 2022
@hadley
Copy link
Member

hadley commented Jan 6, 2022

Thanks Jenny!

@hadley hadley deleted the tweak-relative-links-only branch January 6, 2022 02:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants