Parcourir la source

Add an example to each style function

tags/v0.3.0
Garrick Aden-Buie il y a 6 ans
Parent
révision
b6df901b66
20 fichiers modifiés avec 256 ajouts et 0 suppressions
  1. +13
    -0
      man-roxygen/style_duo.R
  2. +13
    -0
      man-roxygen/style_duo_accent.R
  3. +13
    -0
      man-roxygen/style_duo_accent_inverse.R
  4. +12
    -0
      man-roxygen/style_mono_accent.R
  5. +12
    -0
      man-roxygen/style_mono_accent_inverse.R
  6. +12
    -0
      man-roxygen/style_mono_dark.R
  7. +12
    -0
      man-roxygen/style_mono_light.R
  8. +11
    -0
      man-roxygen/style_solarized_dark.R
  9. +11
    -0
      man-roxygen/style_solarized_light.R
  10. +14
    -0
      man-roxygen/style_xaringan.R
  11. +14
    -0
      man/style_duo.Rd
  12. +14
    -0
      man/style_duo_accent.Rd
  13. +14
    -0
      man/style_duo_accent_inverse.Rd
  14. +13
    -0
      man/style_mono_accent.Rd
  15. +13
    -0
      man/style_mono_accent_inverse.Rd
  16. +13
    -0
      man/style_mono_dark.Rd
  17. +13
    -0
      man/style_mono_light.Rd
  18. +12
    -0
      man/style_solarized_dark.Rd
  19. +12
    -0
      man/style_solarized_light.Rd
  20. +15
    -0
      man/style_xaringan.Rd

+ 13
- 0
man-roxygen/style_duo.R Voir le fichier

#' @title Duotone Theme #' @title Duotone Theme
#' @description A duotone theme designed to work well with two complementary #' @description A duotone theme designed to work well with two complementary
#' colors. #' colors.
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_duo(
#' primary_color = "#1f4257",
#' secondary_color = "#f97b64",
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 13
- 0
man-roxygen/style_duo_accent.R Voir le fichier

#' @title Duotone Accent Theme #' @title Duotone Accent Theme
#' @description An default xaringan theme with a two colors used for color #' @description An default xaringan theme with a two colors used for color
#' accents on select elements (headers, bold text, etc.). #' accents on select elements (headers, bold text, etc.).
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_duo_accent(
#' primary_color = "#006747",
#' secondary_color = "#cfc493",
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 13
- 0
man-roxygen/style_duo_accent_inverse.R Voir le fichier

#' @title Duotone Accent Inverse Theme #' @title Duotone Accent Inverse Theme
#' @description An "inverted" default xaringan theme with a two colors used #' @description An "inverted" default xaringan theme with a two colors used
#' for color accents on select elements (headers, bold text, etc.). #' for color accents on select elements (headers, bold text, etc.).
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_duo_accent_inverse(
#' primary_color = "#006747",
#' secondary_color = "#cfc493",
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 12
- 0
man-roxygen/style_mono_accent.R Voir le fichier

#' @title Monotone Accent Theme #' @title Monotone Accent Theme
#' @description The default xaringan theme with a single color used for color #' @description The default xaringan theme with a single color used for color
#' accents on select elements (headers, bold text, etc.). #' accents on select elements (headers, bold text, etc.).
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_mono_accent(
#' base_color = "#43418A",
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 12
- 0
man-roxygen/style_mono_accent_inverse.R Voir le fichier

#' @title Monotone Accent Inverse Theme #' @title Monotone Accent Inverse Theme
#' @description An "inverted" default xaringan theme with a single color used #' @description An "inverted" default xaringan theme with a single color used
#' for color accents on select elements (headers, bold text, etc.). #' for color accents on select elements (headers, bold text, etc.).
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_mono_accent_inverse(
#' base_color = "#3c989e",
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 12
- 0
man-roxygen/style_mono_dark.R Voir le fichier

#' @title Monotone Dark Theme #' @title Monotone Dark Theme
#' @description A dark monotone theme based around a single color. #' @description A dark monotone theme based around a single color.
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_mono_dark(
#' base_color = "#cbf7ed",
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 12
- 0
man-roxygen/style_mono_light.R Voir le fichier

#' @title Monotone Light Theme #' @title Monotone Light Theme
#' @description A light monotone theme based around a single color. #' @description A light monotone theme based around a single color.
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_mono_light(
#' base_color = "#23395b",
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 11
- 0
man-roxygen/style_solarized_dark.R Voir le fichier

#' Works well with "\code{highlightStyle: solarized-dark}" or #' Works well with "\code{highlightStyle: solarized-dark}" or
#' "\code{highlighStyle: solarized-light}". #' "\code{highlighStyle: solarized-light}".
#' @references \url{http://ethanschoonover.com/solarized} #' @references \url{http://ethanschoonover.com/solarized}
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_solarized_dark(
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 11
- 0
man-roxygen/style_solarized_light.R Voir le fichier

#' Works well with "\code{highlightStyle: solarized-dark}" or #' Works well with "\code{highlightStyle: solarized-dark}" or
#' "\code{highlighStyle: solarized-light}". #' "\code{highlighStyle: solarized-light}".
#' @references \url{http://ethanschoonover.com/solarized} #' @references \url{http://ethanschoonover.com/solarized}
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_solarized_light(
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 14
- 0
man-roxygen/style_xaringan.R Voir le fichier

#' @title Write A Customized Xaringan Theme #' @title Write A Customized Xaringan Theme
#' @description Creates a customized Xaringan theme CSS file. #' @description Creates a customized Xaringan theme CSS file.
#' @examples
#' # Create a xaringan style in a temporary file
#' xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
#'
#' style_xaringan(
#' text_color = "#002b3",
#' inverse_background_color = "#31b09e",
#' inverse_text_color = "#002b3",
#' outfile = xaringan_themer_css # omit in your slides to write the
#' # styles to xaringan-themer.css
#' )
#'
#' # View the CSS:
#' # file.edit(xaringan_themer_css)

+ 14
- 0
man/style_duo.Rd Voir le fichier

A duotone theme designed to work well with two complementary A duotone theme designed to work well with two complementary
colors. colors.
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_duo(
primary_color = "#1f4257",
secondary_color = "#f97b64",
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\seealso{ \seealso{
Other themes: Other themes:
\code{\link{style_duo_accent_inverse}()}, \code{\link{style_duo_accent_inverse}()},

+ 14
- 0
man/style_duo_accent.Rd Voir le fichier

An default xaringan theme with a two colors used for color An default xaringan theme with a two colors used for color
accents on select elements (headers, bold text, etc.). accents on select elements (headers, bold text, etc.).
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_duo_accent(
primary_color = "#006747",
secondary_color = "#cfc493",
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\seealso{ \seealso{
Other themes: Other themes:
\code{\link{style_duo_accent_inverse}()}, \code{\link{style_duo_accent_inverse}()},

+ 14
- 0
man/style_duo_accent_inverse.Rd Voir le fichier

An "inverted" default xaringan theme with a two colors used An "inverted" default xaringan theme with a two colors used
for color accents on select elements (headers, bold text, etc.). for color accents on select elements (headers, bold text, etc.).
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_duo_accent_inverse(
primary_color = "#006747",
secondary_color = "#cfc493",
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\seealso{ \seealso{
Other themes: Other themes:
\code{\link{style_duo_accent}()}, \code{\link{style_duo_accent}()},

+ 13
- 0
man/style_mono_accent.Rd Voir le fichier

The default xaringan theme with a single color used for color The default xaringan theme with a single color used for color
accents on select elements (headers, bold text, etc.). accents on select elements (headers, bold text, etc.).
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_mono_accent(
base_color = "#43418A",
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\seealso{ \seealso{
Other themes: Other themes:
\code{\link{style_duo_accent_inverse}()}, \code{\link{style_duo_accent_inverse}()},

+ 13
- 0
man/style_mono_accent_inverse.Rd Voir le fichier

An "inverted" default xaringan theme with a single color used An "inverted" default xaringan theme with a single color used
for color accents on select elements (headers, bold text, etc.). for color accents on select elements (headers, bold text, etc.).
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_mono_accent_inverse(
base_color = "#3c989e",
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\seealso{ \seealso{
Other themes: Other themes:
\code{\link{style_duo_accent_inverse}()}, \code{\link{style_duo_accent_inverse}()},

+ 13
- 0
man/style_mono_dark.Rd Voir le fichier

\description{ \description{
A dark monotone theme based around a single color. A dark monotone theme based around a single color.
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_mono_dark(
base_color = "#cbf7ed",
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\seealso{ \seealso{
Other themes: Other themes:
\code{\link{style_duo_accent_inverse}()}, \code{\link{style_duo_accent_inverse}()},

+ 13
- 0
man/style_mono_light.Rd Voir le fichier

\description{ \description{
A light monotone theme based around a single color. A light monotone theme based around a single color.
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_mono_light(
base_color = "#23395b",
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\seealso{ \seealso{
Other themes: Other themes:
\code{\link{style_duo_accent_inverse}()}, \code{\link{style_duo_accent_inverse}()},

+ 12
- 0
man/style_solarized_dark.Rd Voir le fichier

Works well with "\code{highlightStyle: solarized-dark}" or Works well with "\code{highlightStyle: solarized-dark}" or
"\code{highlighStyle: solarized-light}". "\code{highlighStyle: solarized-light}".
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_solarized_dark(
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\references{ \references{
\url{http://ethanschoonover.com/solarized} \url{http://ethanschoonover.com/solarized}
} }

+ 12
- 0
man/style_solarized_light.Rd Voir le fichier

Works well with "\code{highlightStyle: solarized-dark}" or Works well with "\code{highlightStyle: solarized-dark}" or
"\code{highlighStyle: solarized-light}". "\code{highlighStyle: solarized-light}".
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_solarized_light(
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\references{ \references{
\url{http://ethanschoonover.com/solarized} \url{http://ethanschoonover.com/solarized}
} }

+ 15
- 0
man/style_xaringan.Rd Voir le fichier

\description{ \description{
Creates a customized Xaringan theme CSS file. Creates a customized Xaringan theme CSS file.
} }
\examples{
# Create a xaringan style in a temporary file
xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")

style_xaringan(
text_color = "#002b3",
inverse_background_color = "#31b09e",
inverse_text_color = "#002b3",
outfile = xaringan_themer_css # omit in your slides to write the
# styles to xaringan-themer.css
)

# View the CSS:
# file.edit(xaringan_themer_css)
}
\seealso{ \seealso{
Other themes: Other themes:
\code{\link{style_duo_accent_inverse}()}, \code{\link{style_duo_accent_inverse}()},

Chargement…
Annuler
Enregistrer