Update customise.Rmd to advice for search on the right.
#2710
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hadley
reviewed
Jul 10, 2024
vignettes/customise.Rmd
Outdated
| @@ -333,7 +333,7 @@ For example, the following yaml adds a new "twitter" component that appears to t | |||
| ``` yaml | |||
| navbar: | |||
| structure: | |||
| right: [twitter, github] | |||
| right: [search, twitter, github] | |||
There was a problem hiding this comment.
You'd also need to add lightswitch here, if you're using the light switch. Not sure if you want to mention that or not?
There was a problem hiding this comment.
Agreed! better to mention it as specifying right has the "power" to make you loose search and lightswitch if not added explicitly?
There was a problem hiding this comment.
Maybe it's worth adding a sentence to that effect? Something like: The downside of customising that navbar in this way is that you have to specify the other components that are specified by default, and if pkgdown later changes the defaults, you'll have to update you _pkgdown.yml.
There was a problem hiding this comment.
I added the note elsewhere. Let me know what you think
olivroy
commented
Jul 10, 2024
hadley
reviewed
Jul 11, 2024
Co-authored-by: Hadley Wickham <[email protected]>
hadley
approved these changes
Jul 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed that users who specify
righthave lost theirsearchas part of pkgdown 2.1.0. So, I thought it'd be good to update the suggestion for template