From 174189beac0e41cb2a93a257d4f7aa5b5c1cbd35 Mon Sep 17 00:00:00 2001 From: olivroy <52606734+olivroy@users.noreply.github.com> Date: Wed, 10 Jul 2024 08:26:49 -0400 Subject: [PATCH 1/4] Update customise.Rmd to advice for `search` on the right. --- vignettes/customise.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vignettes/customise.Rmd b/vignettes/customise.Rmd index 104df56e3..69675a30f 100644 --- a/vignettes/customise.Rmd +++ b/vignettes/customise.Rmd @@ -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] components: twitter: icon: fa-twitter From 6009ccaa97119789855231b4f7e40d5635d75b19 Mon Sep 17 00:00:00 2001 From: olivroy <52606734+olivroy@users.noreply.github.com> Date: Wed, 10 Jul 2024 10:18:20 -0400 Subject: [PATCH 2/4] Update vignettes/customise.Rmd --- vignettes/customise.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vignettes/customise.Rmd b/vignettes/customise.Rmd index 69675a30f..cddca6ed4 100644 --- a/vignettes/customise.Rmd +++ b/vignettes/customise.Rmd @@ -333,7 +333,7 @@ For example, the following yaml adds a new "twitter" component that appears to t ``` yaml navbar: structure: - right: [search, twitter, github] + right: [search, twitter, github, lightswitch] components: twitter: icon: fa-twitter From ea9d60ff3c70d775aaf546cf0d7eacdb767ad5a0 Mon Sep 17 00:00:00 2001 From: olivroy <52606734+olivroy@users.noreply.github.com> Date: Thu, 11 Jul 2024 08:19:56 -0400 Subject: [PATCH 3/4] Add note about downside of customising --- vignettes/customise.Rmd | 2 ++ 1 file changed, 2 insertions(+) diff --git a/vignettes/customise.Rmd b/vignettes/customise.Rmd index cddca6ed4..21d630a1b 100644 --- a/vignettes/customise.Rmd +++ b/vignettes/customise.Rmd @@ -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`. From ba178897fc425e72243f20c4fa6ac7b3cde0d898 Mon Sep 17 00:00:00 2001 From: olivroy <52606734+olivroy@users.noreply.github.com> Date: Thu, 11 Jul 2024 08:45:23 -0400 Subject: [PATCH 4/4] Update vignettes/customise.Rmd Co-authored-by: Hadley Wickham --- vignettes/customise.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vignettes/customise.Rmd b/vignettes/customise.Rmd index 21d630a1b..44e5691ad 100644 --- a/vignettes/customise.Rmd +++ b/vignettes/customise.Rmd @@ -282,7 +282,7 @@ 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. +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`.