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 all commits
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
4 changes: 3 additions & 1 deletion vignettes/customise.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,8 @@ It makes use of the the following built-in components:
- `github`, a link to the source repository (with an icon), if it can be automatically determined from the `DESCRIPTION`.
- `lightswitch`, a ["light switch"](#light-switch) to select light mode, dark mode, or auto mode.

Note that customising `navbar` like this comes with a downside: if pkgdown later changes the defaults, you'll have to update your `_pkgdown.yml`.

[^dots]: Note that dots (`.`) in the package name need to be replaced by hyphens (`-`) in the vignette filename to be recognized as the intro. That means for a
package `foo.bar` the intro needs to be named `foo-bar.Rmd`.

Expand Down Expand Up @@ -333,7 +335,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, lightswitch]
components:
twitter:
icon: fa-twitter
Expand Down
Loading