😎 Give your xaringan slides some style
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.

157 lines
9.9KB

  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. padding = "1em 4em 1em 4em", background_image = NA,
  11. background_size = NA, background_position = NA,
  12. code_highlight_color = "rgba(255,255,0,0.5)", code_inline_color = "#000",
  13. code_inline_background_color = NA, code_inline_font_size = "1em",
  14. inverse_background_color = "#272822", inverse_text_color = "#d6d6d6",
  15. inverse_text_shadow = FALSE, inverse_header_color = "#f3f3f3",
  16. title_slide_text_color = inverse_text_color,
  17. title_slide_background_color = inverse_background_color,
  18. title_slide_background_image = NA, title_slide_background_size = NA,
  19. title_slide_background_position = NA, footnote_color = NA,
  20. footnote_font_size = "0.9em", footnote_position_bottom = "3em",
  21. left_column_subtle_color = "#777", left_column_selected_color = "#000",
  22. blockquote_left_border_color = "lightgray", table_border_color = "#666",
  23. table_row_border_color = "#ddd", table_row_even_background_color = "#eee",
  24. text_font_size = "20px", header_h1_font_size = "55px",
  25. header_h2_font_size = "45px", header_h3_font_size = "35px",
  26. text_slide_number_font_size = "0.9em", text_font_google = NULL,
  27. text_font_family = "'Droid Serif'", text_font_weight = "normal",
  28. text_font_url = "https://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic",
  29. text_font_family_fallback = "'Palatino Linotype', 'Book Antiqua', Palatino, 'Microsoft YaHei', 'Songti SC'",
  30. text_font_base = "serif", header_font_google = NULL,
  31. header_font_family = "'Yanone Kaffeesatz'", header_font_weight = "normal",
  32. header_font_url = "https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz",
  33. code_font_google = NULL, code_font_family = "'Source Code Pro'",
  34. code_font_size = "0.9em",
  35. code_font_url = "https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700",
  36. code_font_family_fallback = "'Lucida Console', Monaco", extra_css = NULL,
  37. extra_fonts = NULL, outfile = "xaringan-themer.css")
  38. }
  39. \arguments{
  40. \item{text_color}{Text Color. Defaults to #000. Modifies the \code{body} element.}
  41. \item{header_color}{Header Color. Defaults to #000. Modifies the \code{h1, h2, h3} elements.}
  42. \item{background_color}{Slide Background Color. Defaults to #FFF. Modifies the \code{.remark-slide-content} class.}
  43. \item{link_color}{Link Color. Defaults to rgb(249, 38, 114). Modifies the \code{a, a > code} elements.}
  44. \item{text_bold_color}{Bold Text Color. Defaults to NA. Modifies the \code{strong} element.}
  45. \item{text_slide_number_color}{Slide Number Color. Defaults to \code{inverse_background_color}. Modifies the \code{.remark-slide-number} class.}
  46. \item{padding}{Slide Padding in \code{top right [bottom left]} format. Defaults to 1em 4em 1em 4em. Modifies the \code{.remark-slide-content} class.}
  47. \item{background_image}{Background image applied to each \emph{and every} slide. Set \code{title_slide_background_image = "none"} to remove the background image from the title slide.. Defaults to NA. Modifies the \code{.remark-slide-content} class.}
  48. \item{background_size}{Background image size, requires \code{background_image} to be set. If \code{background_image} is set, \code{background_size} will default to \code{cover} so the backround fills the screen. If both \code{background_image} and \code{background_position} are set, will default to 100 percent.. Defaults to NA. Modifies the \code{.remark-slide-content} class.}
  49. \item{background_position}{Background image position, requires \code{background_image} to be set, and it is recommended to adjust \code{background_size}.. Defaults to NA. Modifies the \code{.remark-slide-content} class.}
  50. \item{code_highlight_color}{Code Line Highlight. Defaults to rgba(255,255,0,0.5). Modifies the \code{.remark-code-line-highlighted} class.}
  51. \item{code_inline_color}{Inline Code Color. Defaults to #000. Modifies the \code{.remark-inline-code} class.}
  52. \item{code_inline_background_color}{Inline Code Background Color. Defaults to NA. Modifies the \code{.remark-inline-code} class.}
  53. \item{code_inline_font_size}{Inline Code Text Font Size. Defaults to 1em. Modifies the \code{.remark-inline-code} class.}
  54. \item{inverse_background_color}{Inverse Background Color. Defaults to #272822. Modifies the \code{.inverse} class.}
  55. \item{inverse_text_color}{Inverse Text Color. Defaults to #d6d6d6. Modifies the \code{.inverse} class.}
  56. \item{inverse_text_shadow}{Enables Shadow on text of inverse slides. Defaults to \code{FALSE}. Modifies the \code{.inverse} class.}
  57. \item{inverse_header_color}{Inverse Header Color. Defaults to #f3f3f3. Modifies the \code{.inverse h1, .inverse h2, .inverse h3} classes.}
  58. \item{title_slide_text_color}{Title Slide Text Color. Defaults to \code{inverse_text_color}. Modifies the \code{.title-slide} class.}
  59. \item{title_slide_background_color}{Title Slide Background Color. Defaults to \code{inverse_background_color}. Modifies the \code{.title-slide} class.}
  60. \item{title_slide_background_image}{Title Slide Background Image URL. Defaults to NA. Modifies the \code{.title-slide} class.}
  61. \item{title_slide_background_size}{Title Slide Background Image Size, defaults to "cover" if background image is set. Defaults to NA. Modifies the \code{.title-slide} class.}
  62. \item{title_slide_background_position}{Title Slide Background Image Position. Defaults to NA. Modifies the \code{.title-slide} class.}
  63. \item{footnote_color}{Footnote text color (if \code{NA}, then it will be the same color as \code{text_color}). Defaults to NA. Modifies the \code{.footnote} class.}
  64. \item{footnote_font_size}{Footnote font size. Defaults to 0.9em. Modifies the \code{.footnote} class.}
  65. \item{footnote_position_bottom}{Footnote location from bottom of screen. Defaults to 3em. Modifies the \code{.footnote} class.}
  66. \item{left_column_subtle_color}{Left Column Text (not last). Defaults to #777. Modifies the \code{.left-column h2, .left-column h3} classes.}
  67. \item{left_column_selected_color}{Left Column Current Selection. Defaults to #000. Modifies the \code{.left-column h2:last-of-type, .left-column h3:last-child} classes.}
  68. \item{blockquote_left_border_color}{Blockquote Left Border Color. Defaults to lightgray. Modifies the \code{blockquote} element.}
  69. \item{table_border_color}{Table top/bottom border. Defaults to #666. Modifies the \code{table: border-top, border-bottom} elements.}
  70. \item{table_row_border_color}{Table row inner bottom border. Defaults to #ddd. Modifies the \code{table thead th: border-bottom} elements.}
  71. \item{table_row_even_background_color}{Table Even Row Background Color. Defaults to #eee. Modifies the \code{thead, tfoot, tr:nth-child(even)} elements.}
  72. \item{text_font_size}{Slide Body Text Font Size. Defaults to 20px. Modifies the \code{.remark-slide-content} class.}
  73. \item{header_h1_font_size}{h1 Header Text Font Size. Defaults to 55px. Modifies the \code{.remark-slide-content h1} class.}
  74. \item{header_h2_font_size}{h2 Header Text Font Size. Defaults to 45px. Modifies the \code{.remark-slide-content h2} class.}
  75. \item{header_h3_font_size}{h3 Header Text Font Size. Defaults to 35px. Modifies the \code{.remark-slide-content h3} class.}
  76. \item{text_slide_number_font_size}{Slide Number Text Font Size. Defaults to 0.9em. Modifies the \code{.remark-slide-number} class.}
  77. \item{text_font_google}{Use \code{google_font()} to specify body font. Defaults to \code{NULL}. Modifies the \code{body} element.}
  78. \item{text_font_family}{Body Text Font Family. Defaults to 'Droid Serif'. Modifies the \code{body} element.}
  79. \item{text_font_weight}{Body Text Font Weight. Defaults to normal. Modifies the \code{body} element.}
  80. \item{text_font_url}{Body Text Font URL(s). Defaults to https://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic. Modifies the \code{@import url()} elements.}
  81. \item{text_font_family_fallback}{Body Text Font Fallbacks. Defaults to 'Palatino Linotype', 'Book Antiqua', Palatino, 'Microsoft YaHei', 'Songti SC'. Modifies the \code{body} element.}
  82. \item{text_font_base}{Body Text Base Font (Total Failure Fallback). Defaults to serif. Modifies the \code{body} element.}
  83. \item{header_font_google}{Use \code{google_font()} to specify header font. Defaults to \code{NULL}. Modifies the \code{body} element.}
  84. \item{header_font_family}{Header Font Family. Defaults to 'Yanone Kaffeesatz'. Modifies the \code{h1, h2, h3} elements.}
  85. \item{header_font_weight}{Header Font Weight. Defaults to normal. Modifies the \code{h1, h2, h3} elements.}
  86. \item{header_font_url}{Header Font URL. Defaults to https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz. Modifies the \code{@import url} elements.}
  87. \item{code_font_google}{Use \code{google_font()} to specify code font. Defaults to \code{NULL}. Modifies the \code{body} element.}
  88. \item{code_font_family}{Code Font Family. Defaults to 'Source Code Pro'. Modifies the \code{.remark-code, .remark-inline-code} classes.}
  89. \item{code_font_size}{Code Text Font Size. Defaults to 0.9em. Modifies the \code{.remark-inline} class.}
  90. \item{code_font_url}{Code Font URL. Defaults to https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700. Modifies the \code{@import url} elements.}
  91. \item{code_font_family_fallback}{Code Font Fallback. Defaults to 'Lucida Console', Monaco. Modifies the \code{.remark-code, .remark-inline-code} classes.}
  92. \item{extra_css}{A named list of CSS definitions each containing a named list
  93. of CSS property-value pairs, i.e.
  94. \code{list(".class-id" = list("css-property" = "value"))}}
  95. \item{extra_fonts}{A list of additional fonts to import, each list element
  96. can be either a URL as a character string or a call to
  97. \code{\link{google_fonts}()}}
  98. \item{outfile}{Customized xaringan CSS output file name, default is "xaringan-themer.css"}
  99. }
  100. \description{
  101. Creates a customized Xaringan theme CSS file.
  102. }