Skip to content

Conversation

@jennybc
Copy link
Member

@jennybc jennybc commented Nov 11, 2020

Closes #224

@jennybc jennybc changed the title Introduce use_github_pages() Introduce use_github_pages() and use_tidy_pkgdown() Nov 12, 2020
@jennybc jennybc requested a review from hadley November 12, 2020 04:57
@jennybc
Copy link
Member Author

jennybc commented Nov 12, 2020

@hadley Is this what you had in mind?

Copy link
Member

@hadley hadley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! It's above and beyond what I was expecting, and I can see that it's going to save a bunch time and protect us against many minor mistakes when creating websites.

R/pkgdown.R Outdated
#'
#' @rdname tidyverse
#' @export
use_tidy_pkgdown <- function(cname = NULL) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just occurred to me: should we say something about tidytemplate for sites tidyverse org? Or maybe it's not worth it, given adding a new tidyverse package is a relatively rare occurrence.

Copy link
Member Author

@jennybc jennybc Nov 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's possible we should offer ourselves better templating for pkgdown config, but I definitely would not get into that here in this PR or, probably for v2.0.0.

@jennybc jennybc merged commit 514acba into master Nov 12, 2020
@jennybc jennybc deleted the use-github-pages branch November 12, 2020 21:11
Remotes:
r-lib/gert,
r-lib/gh
r-lib/gh#139
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is going to fail as soon as the PR is closed. It's a bit safer (but not as descriptive) to refer to a branch with the @branch notation instead.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't plan for this situation to last very long, but yes you're right.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both are going to break when we merge and delete the branch. I'll update this as soon as we merge in gh.

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.

Could use_github_pages() turn on GitHub Pages?

4 participants