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

build_home(): reduced priority for "index.Rmd" in pkgdown v1.4 #1136

Closed
mrustl opened this issue Sep 4, 2019 · 2 comments
Closed

build_home(): reduced priority for "index.Rmd" in pkgdown v1.4 #1136

mrustl opened this issue Sep 4, 2019 · 2 comments
Labels
documentation wip work in progress
Milestone

Comments

@mrustl
Copy link

mrustl commented Sep 4, 2019

While in pkgdown v1.3 the priority for building the home index.html was as follows:

c("index.Rmd", "README.Rmd", "index.md", "README.md")

It was changed with pkgdown v1.4 to:

c("index.md", "README.md", "index.Rmd", "README.Rmd")

In order to be backward compatible, it would be great if the priority could be changed back to the one used in pkgdown v1.3 or as follows:

c("index.md", "index.Rmd", "README.md", "README.Rmd")

This would be really helpful as our > 40 company open-source R package repositories (https://kwb-r.github.io/status), which all use pkgdown, rely on the fact that index.Rmd is prioritised higher than README.md

mrustl added a commit to KWB-R/kwb.pkgbuild that referenced this issue Sep 4, 2019
mrustl added a commit to KWB-R/fhpredict that referenced this issue Sep 5, 2019
mrustl added a commit to KWB-R/kwb.code that referenced this issue Sep 5, 2019
mrustl added a commit to KWB-R/kwb.pkgbuild that referenced this issue Sep 5, 2019
mrustl added a commit to KWB-R/kwb.utils that referenced this issue Sep 5, 2019
for details see: r-lib/pkgdown#1136

and in addition also improve installation description with kwb.pkgbuild:::use_installation()
mrustl added a commit to KWB-R/pkgmeta that referenced this issue Sep 5, 2019
mrustl added a commit to KWB-R/kwb.pathdict that referenced this issue Sep 5, 2019
mrustl added a commit to KWB-R/kwb.fakin that referenced this issue Sep 5, 2019
@hadley
Copy link
Member

hadley commented Sep 5, 2019

pkgdown no longer renders .Rmd to .md, so I don't think changing the order of that vector will help you. Instead, I think you'll need to add a rmarkdown::render() in your deployment process.

mrustl added a commit to KWB-R/kwb.pkgbuild that referenced this issue Sep 6, 2019
as ".Rmd" is not rendered anymore by pkgdown v1.4 due to adapted workflow as explained by @hadley in r-lib/pkgdown#1136
mrustl added a commit to mrustl/pkgdown that referenced this issue Sep 6, 2019
@mrustl
Copy link
Author

mrustl commented Sep 6, 2019

@hadley thanks for explaining this. This was not obvious for me as the pkgdown v1.4 documentation just mentions:

build_home() no longer re-builds README.Rmd
https://pkgdown.r-lib.org/news/#new-features

In addition listing the ".Rmd" files in build_home_index() is counterintuitive:

c("index.md", "README.md", "index.Rmd", "README.Rmd")

For being more explicit on this I propose #1140

mrustl added a commit to KWB-R/fakin.path.app that referenced this issue Sep 6, 2019
mrustl added a commit to KWB-R/kwb.flusshygiene.app that referenced this issue Sep 6, 2019
mrustl added a commit to KWB-R/kwb.file that referenced this issue Sep 6, 2019
mrustl added a commit to KWB-R/kwb.dwd that referenced this issue Sep 6, 2019
mrustl added a commit to KWB-R/algoliar that referenced this issue Sep 9, 2019
see: r-lib/pkgdown#1136

and also deploy 📖 from "dev" branch
mrustl added a commit to KWB-R/kwb.event that referenced this issue Sep 9, 2019
see: r-lib/pkgdown#1136

and also deploy 📖 from "dev" branch
mrustl added a commit to KWB-R/kwb.default that referenced this issue Sep 9, 2019
see: r-lib/pkgdown#1136

and also deploy 📖 from "dev" branch
mrustl added a commit to KWB-R/aquanes.report that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.pubs that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.readxl that referenced this issue Sep 9, 2019
see: r-lib/pkgdown#1136

and also deploy 📖 from "dev" branch
mrustl added a commit to KWB-R/kwb.umberto that referenced this issue Sep 9, 2019
see: r-lib/pkgdown#1136

and also deploy 📖 from "dev" branch
mrustl added a commit to KWB-R/kwb.endnote that referenced this issue Sep 9, 2019
see: r-lib/pkgdown#1136

and also deploy 📖 from "dev" branch
mrustl added a commit to KWB-R/kwb.orcid that referenced this issue Sep 9, 2019
see: r-lib/pkgdown#1136

and also deploy 📖 from "dev" branch
mrustl added a commit to KWB-R/kwb.vs2dh that referenced this issue Sep 9, 2019
see: r-lib/pkgdown#1136

and also deploy 📖 from "dev" branch
mrustl added a commit to KWB-R/kwb.demeau that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.read that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.lca that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.base that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.wtaq that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.resilience that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.test that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.hantush that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.en13508.2 that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.dwa.m150 that referenced this issue Sep 9, 2019
mrustl added a commit to KWB-R/kwb.svn that referenced this issue Sep 13, 2019
@hadley hadley added documentation wip work in progress labels Mar 10, 2020
@hadley hadley added this to the 1.5.0 milestone Mar 11, 2020
@hadley hadley closed this as completed in 880a1c9 Mar 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation wip work in progress
Projects
None yet
Development

No branches or pull requests

2 participants