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

Emit warning when readme contains figures in wrong directory #1197

Closed
jeroen opened this issue Dec 16, 2019 · 4 comments · Fixed by #1810
Closed

Emit warning when readme contains figures in wrong directory #1197

jeroen opened this issue Dec 16, 2019 · 4 comments · Fixed by #1810
Labels
documentation feature a feature request or enhancement home 🏠

Comments

@jeroen
Copy link
Member

jeroen commented Dec 16, 2019

There are a lot of pkgdown sites with broken figures on the homepage because most maintainers are not aware that pkgdown only supports images in a few locations since only a few locations also work with CRAN's rendering of readme.md.

This could be documented a bit better and perhaps it would be helpful if build_site() emits a warning when the readme contains figures to relative paths in source folder that are not supported by pkgdown, and a hint to move these to e.g. ./man/figures/

@maelle

@hadley hadley added feature a feature request or enhancement home 🏠 labels Mar 10, 2020
@gabora

This comment has been minimized.

@dmurdoch

This comment has been minimized.

@gabora

This comment has been minimized.

@dmurdoch

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation feature a feature request or enhancement home 🏠
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants