Add section on usage to all style functions

R/style_duo.R

@@ -216,6 +216,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_duo
 #' @family Duotone themes
 #' @export

R/style_duo_accent.R

@@ -224,6 +224,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_duo_accent
 #' @family Duotone themes
 #' @export

R/style_duo_accent_inverse.R

@@ -225,6 +225,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_duo_accent_inverse
 #' @family Duotone themes
 #' @export

R/style_mono_accent.R

@@ -217,6 +217,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_mono_accent
 #' @family Monotone themes
 #' @export

R/style_mono_accent_inverse.R

@@ -218,6 +218,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_mono_accent_inverse
 #' @family Monotone themes
 #' @export

R/style_mono_dark.R

@@ -219,6 +219,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_mono_dark
 #' @family Monotone themes
 #' @export

R/style_mono_light.R

@@ -219,6 +219,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_mono_light
 #' @family Monotone themes
 #' @export

R/style_solarized_dark.R

@@ -210,6 +210,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_solarized_dark
 #' @family Solarized themes
 #' @export

R/style_solarized_light.R

@@ -210,6 +210,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_solarized_light
 #' @family Solarized themes
 #' @export

R/style_xaringan.R

@@ -210,6 +210,7 @@
 #'   Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
 #'   `.remark-code, .remark-inline-code` classes.
 #' @template theme_params
+#' @template style-usage
 #' @template style_xaringan
 #' @export
 style_xaringan <- function(

inst/scripts/generate_theme_functions.R

@@ -27,6 +27,7 @@ setup_theme_function <- function(
       )
     ),
     "#' @template theme_params",
+    "#' @template style-usage",
     ...,
     glue::glue("{f_name} <- function("),
     as.character(

man-roxygen/style-usage.R

@@ -0,0 +1,11 @@
+#' @section Usage: To use the styles created by this theme function, make sure
+#'   that you use `xaringan-themer.css` as your CSS file in your slides' YAML
+#'   header. If you change the name of the output file using the `outfile`
+#'   argument, use that name instead of the default file name.
+#'
+#' ```yaml
+#' output:
+#' xaringan::moon_reader:
+#'   css: xaringan-themer.css`
+#' ````
+#

man/style_duo.Rd

@@ -378,6 +378,16 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 A duotone theme designed to work well with two complementary
 colors.
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

man/style_duo_accent.Rd

@@ -391,6 +391,16 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 An default xaringan theme with a two colors used for color
 accents on select elements (headers, bold text, etc.).
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

man/style_duo_accent_inverse.Rd

@@ -393,6 +393,16 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 An "inverted" default xaringan theme with a two colors used
 for color accents on select elements (headers, bold text, etc.).
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

man/style_mono_accent.Rd

@@ -380,6 +380,16 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 The default xaringan theme with a single color used for color
 accents on select elements (headers, bold text, etc.).
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

man/style_mono_accent_inverse.Rd

@@ -381,6 +381,16 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 An "inverted" default xaringan theme with a single color used
 for color accents on select elements (headers, bold text, etc.).
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

man/style_mono_dark.Rd

@@ -381,6 +381,16 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 \description{
 A dark monotone theme based around a single color.
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

man/style_mono_light.Rd

@@ -381,6 +381,16 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 \description{
 A light monotone theme based around a single color.
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

man/style_solarized_dark.Rd

@@ -368,6 +368,16 @@ A dark theme based around on the solarized color scheme.
 Works well with "\code{highlightStyle: solarized-dark}" or
 "\code{highlighStyle: solarized-light}".
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

man/style_solarized_light.Rd

@@ -368,6 +368,16 @@ A light theme based around on the solarized color scheme.
 Works well with "\code{highlightStyle: solarized-dark}" or
 "\code{highlighStyle: solarized-light}".
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

man/style_xaringan.Rd

@@ -366,6 +366,16 @@ class with the \code{font-family} property. See the \strong{Fonts} section of
 \description{
 Creates a customized Xaringan theme CSS file.
 }
+\section{Usage}{
+ To use the styles created by this theme function, make sure
+that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
+header. If you change the name of the output file using the \code{outfile}
+argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
+xaringan::moon_reader:
+  css: xaringan-themer.css`
+}\if{html}{\out{</div>}}
+}
+
 \examples{
 # Create a xaringan style in a temporary file
 xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")