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.

Sign up for GitHub

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

Jump to bottom

Update customise.Rmd to advice for search on the right. #2710

Merged
merged 4 commits into from
Jul 11, 2024
Merged

Update customise.Rmd to advice for search on the right. #2710

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
174189b
Update customise.Rmd to advice for `search` on the right.
olivroy Jul 10, 2024
6009cca
Update vignettes/customise.Rmd
olivroy Jul 10, 2024
ea9d60f
Add note about downside of customising
olivroy Jul 11, 2024
ba17889
Update vignettes/customise.Rmd
olivroy Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion vignettes/customise.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Copy link
Member

@hadley hadley Jul 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Agreed! better to mention it as specifying right has the "power" to make you loose search and lightswitch if not added explicitly?

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added the note elsewhere. Let me know what you think

olivroy marked this conversation as resolved.
Show resolved Hide resolved
components:
twitter:
icon: fa-twitter
Expand Down
Loading