😎 Give your xaringan slides some style
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

140 lines
6.2KB

  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/write_theme.R
  3. \name{write_xaringan_theme}
  4. \alias{write_xaringan_theme}
  5. \title{Write A Customized Xaringan Theme}
  6. \usage{
  7. write_xaringan_theme(text_color = "#000", header_color = "#000",
  8. background_color = "#FFF", link_color = "rgb(249, 38, 114)",
  9. text_bold_color = NA, text_slide_number_color = inverse_background_color,
  10. code_highlight_color = "rgba(255,255,0,0.5)", code_inline_color = "#000",
  11. code_inline_background_color = NA, inverse_background_color = "#272822",
  12. inverse_text_color = "#d6d6d6", inverse_text_shadow = FALSE,
  13. inverse_header_color = "#f3f3f3",
  14. title_slide_text_color = inverse_text_color,
  15. title_slide_background_color = inverse_background_color,
  16. title_slide_background_image = NA, title_slide_background_size = NA,
  17. title_slide_background_position = NA, left_column_subtle_color = "#777",
  18. left_column_selected_color = "#000", blockquote_left_color = "lightgray",
  19. table_border_color = "#666", table_row_border_color = "#ddd",
  20. table_row_even_background_color = "#eee", text_font_size = "20px",
  21. header_h1_font_size = "55px", header_h2_font_size = "45px",
  22. header_h3_font_size = "35px", text_slide_number_font_size = "0.9em",
  23. code_inline_font_size = "1em", code_font_size = "0.9em",
  24. text_font_google = NULL, text_font_family = "'Droid Serif'",
  25. text_font_weight = "normal",
  26. text_font_url = "https://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic",
  27. text_font_family_fallback = "'Palatino Linotype', 'Book Antiqua', Palatino, 'Microsoft YaHei', 'Songti SC'",
  28. text_font_base = "serif", header_font_google = NULL,
  29. header_font_family = "'Yanone Kaffeesatz'", header_font_weight = "normal",
  30. header_font_url = "https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz",
  31. code_font_google = NULL, code_font_family = "'Source Code Pro'",
  32. code_font_url = "https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700",
  33. code_font_family_fallback = "'Lucida Console', Monaco", extra_css = NULL,
  34. extra_fonts = NULL, outfile = "xaringan-themer.css")
  35. }
  36. \arguments{
  37. \item{text_color}{Text Color, defaults to #000}
  38. \item{header_color}{Header Color, defaults to #000}
  39. \item{background_color}{Slide Background Color, defaults to #FFF}
  40. \item{link_color}{Link Color, defaults to rgb(249, 38, 114)}
  41. \item{text_bold_color}{Bold Text Color, defaults to NA}
  42. \item{text_slide_number_color}{Slide Number Color, defaults to \code{inverse_background_color}}
  43. \item{code_highlight_color}{Code Line Highlight, defaults to rgba(255,255,0,0.5)}
  44. \item{code_inline_color}{Inline Code Color, defaults to #000}
  45. \item{code_inline_background_color}{Inline Code Background Color, defaults to NA}
  46. \item{inverse_background_color}{Inverse Background Color, defaults to #272822}
  47. \item{inverse_text_color}{Inverse Text Color, defaults to #d6d6d6}
  48. \item{inverse_text_shadow}{Enables Shadow on text of inverse slides, defaults to \code{FALSE}}
  49. \item{inverse_header_color}{Inverse Header Color, defaults to #f3f3f3}
  50. \item{title_slide_text_color}{Title Slide Text Color, defaults to \code{inverse_text_color}}
  51. \item{title_slide_background_color}{Title Slide Background Color, defaults to \code{inverse_background_color}}
  52. \item{title_slide_background_image}{Title Slide Background Image URL, defaults to NA}
  53. \item{title_slide_background_size}{Title Slide Background Image Size, defaults to "cover" if background image is set, defaults to NA}
  54. \item{title_slide_background_position}{Title Slide Background Image Position, defaults to NA}
  55. \item{left_column_subtle_color}{Left Column Text (not last), defaults to #777}
  56. \item{left_column_selected_color}{Left Column Current Selection, defaults to #000}
  57. \item{blockquote_left_color}{Blockquote Left Border Color, defaults to lightgray}
  58. \item{table_border_color}{Table top/bottom border, defaults to #666}
  59. \item{table_row_border_color}{Table row inner bottom border, defaults to #ddd}
  60. \item{table_row_even_background_color}{Table Even Row Background Color, defaults to #eee}
  61. \item{text_font_size}{Slide Body Text Font Size, defaults to 20px}
  62. \item{header_h1_font_size}{h1 Header Text Font Size, defaults to 55px}
  63. \item{header_h2_font_size}{h2 Header Text Font Size, defaults to 45px}
  64. \item{header_h3_font_size}{h3 Header Text Font Size, defaults to 35px}
  65. \item{text_slide_number_font_size}{Slide Number Text Font Size, defaults to 0.9em}
  66. \item{code_inline_font_size}{Inline Code Text Font Size, defaults to 1em}
  67. \item{code_font_size}{Code Text Font Size, defaults to 0.9em}
  68. \item{text_font_google}{Use \code{google_font()} to specify body font, defaults to \code{NULL}}
  69. \item{text_font_family}{Body Text Font Family, defaults to 'Droid Serif'}
  70. \item{text_font_weight}{Body Text Font Weight, defaults to normal}
  71. \item{text_font_url}{Body Text Font URL(s), defaults to https://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic}
  72. \item{text_font_family_fallback}{Body Text Font Fallbacks, defaults to 'Palatino Linotype', 'Book Antiqua', Palatino, 'Microsoft YaHei', 'Songti SC'}
  73. \item{text_font_base}{Body Text Base Font (Total Failure Fallback), defaults to serif}
  74. \item{header_font_google}{Use \code{google_font()} to specify header font, defaults to \code{NULL}}
  75. \item{header_font_family}{Header Font Family, defaults to 'Yanone Kaffeesatz'}
  76. \item{header_font_weight}{Header Font Weight, defaults to normal}
  77. \item{header_font_url}{Header Font URL, defaults to https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz}
  78. \item{code_font_google}{Use \code{google_font()} to specify code font, defaults to \code{NULL}}
  79. \item{code_font_family}{Code Font Family, defaults to 'Source Code Pro'}
  80. \item{code_font_url}{Code Font URL, defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700}
  81. \item{code_font_family_fallback}{Code Font Fallback, defaults to 'Lucida Console', Monaco}
  82. \item{extra_css}{A named list of CSS definitions each containing a named list
  83. of CSS property-value pairs, i.e.
  84. \code{list(".class-id" = list("css-property" = "value"))}}
  85. \item{extra_fonts}{A list of additional fonts to import, each list element
  86. can be either a URL as a character string or a call to
  87. \code{\link{google_fonts}()}}
  88. \item{outfile}{Customized xaringan CSS output file name, default is "xaringan-themer.css"}
  89. }
  90. \description{
  91. Creates a customized Xaringan theme CSS file.
  92. }