Browse Source

Move extra param documentation to man-roxygen/theme_params.R

tags/v0.3.0
Garrick Aden-Buie 6 years ago
parent
commit
e4dd983e24
13 changed files with 25 additions and 105 deletions
  1. +1
    -9
      R/style_duo.R
  2. +1
    -9
      R/style_duo_accent.R
  3. +1
    -9
      R/style_duo_accent_inverse.R
  4. +1
    -9
      R/style_mono_accent.R
  5. +1
    -9
      R/style_mono_accent_inverse.R
  6. +1
    -9
      R/style_mono_dark.R
  7. +1
    -9
      R/style_mono_light.R
  8. +1
    -9
      R/style_solarized_dark.R
  9. +1
    -9
      R/style_solarized_light.R
  10. +1
    -9
      R/style_xaringan.R
  11. +1
    -9
      inst/scripts/generate_theme_functions.R
  12. +0
    -6
      man-roxygen/extra_css.R
  13. +14
    -0
      man-roxygen/theme_params.R

+ 1
- 9
R/style_duo.R View File

@@ -59,15 +59,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_duo
#' @family Duotone themes
#' @export

+ 1
- 9
R/style_duo_accent.R View File

@@ -61,15 +61,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_duo_accent
#' @family Duotone themes
#' @export

+ 1
- 9
R/style_duo_accent_inverse.R View File

@@ -61,15 +61,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_duo_accent_inverse
#' @family Duotone themes
#' @export

+ 1
- 9
R/style_mono_accent.R View File

@@ -60,15 +60,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_mono_accent
#' @family Monotone themes
#' @export

+ 1
- 9
R/style_mono_accent_inverse.R View File

@@ -60,15 +60,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_mono_accent_inverse
#' @family Monotone themes
#' @export

+ 1
- 9
R/style_mono_dark.R View File

@@ -60,15 +60,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_mono_dark
#' @family Monotone themes
#' @export

+ 1
- 9
R/style_mono_light.R View File

@@ -60,15 +60,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_mono_light
#' @family Monotone themes
#' @export

+ 1
- 9
R/style_solarized_dark.R View File

@@ -57,15 +57,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_solarized_dark
#' @family Solarized themes
#' @export

+ 1
- 9
R/style_solarized_light.R View File

@@ -57,15 +57,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_solarized_light
#' @family Solarized themes
#' @export

+ 1
- 9
R/style_xaringan.R View File

@@ -57,15 +57,7 @@
#' @param code_font_size Code Text Font Size. Defaults to 0.9rem. Modifies the `.remark-inline` class.
#' @param code_font_url Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap. Modifies the `@import url` elements.
#' @param code_font_family_fallback Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the `.remark-code, .remark-inline-code` classes.
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @template extra_css
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes
#' @template theme_params
#' @template style_xaringan
#' @export
style_xaringan <- function(

+ 1
- 9
inst/scripts/generate_theme_functions.R View File

@@ -25,15 +25,7 @@ setup_theme_function <- function(
"{element_description(element)}"
)
),
"#' @param colors A named vector of custom colors. The names of the colors",
"#' become CSS variables and classes that can be used within your slides.",
"#' For example, `colors = c(blue = \"#bad4ed\")` adds a CSS variable",
"#' `--blue`, a `.blue` CSS class that applies the color to the text or",
"#' foreground color, and a `.bg-blue` CSS class that applies the color",
"#' to the background.",
"#' @template extra_css",
"#' @param outfile Customized xaringan CSS output file name, default is \"xaringan-themer.css\"",
"#' @family themes",
"#' @template theme_params",
...,
glue::glue("{f_name} <- function("),
as.character(

+ 0
- 6
man-roxygen/extra_css.R View File

@@ -1,6 +0,0 @@
#' @param extra_css A named list of CSS definitions each containing a named list
#' of CSS property-value pairs, i.e.
#' \code{list(".class-id" = list("css-property" = "value"))}
#' @param extra_fonts A list of additional fonts to import, each list element
#' can be either a URL as a character string or a call to
#' \code{\link{google_font}()}

+ 14
- 0
man-roxygen/theme_params.R View File

@@ -0,0 +1,14 @@
#' @param extra_css A named list of CSS definitions each containing a named list
#' of CSS property-value pairs, i.e.
#' \code{list(".class-id" = list("css-property" = "value"))}
#' @param extra_fonts A list of additional fonts to import, each list element
#' can be either a URL as a character string or a call to
#' \code{\link{google_font}()}
#' @param colors A named vector of custom colors. The names of the colors
#' become CSS variables and classes that can be used within your slides.
#' For example, `colors = c(blue = "#bad4ed")` adds a CSS variable
#' `--blue`, a `.blue` CSS class that applies the color to the text or
#' foreground color, and a `.bg-blue` CSS class that applies the color
#' to the background.
#' @param outfile Customized xaringan CSS output file name, default is "xaringan-themer.css"
#' @family themes

Loading…
Cancel
Save