😎 Give your xaringan slides some style
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

413 lines
18KB

  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/style_solarized_light.R
  3. \name{style_solarized_light}
  4. \alias{style_solarized_light}
  5. \title{Solarized Light Theme}
  6. \usage{
  7. style_solarized_light(
  8. text_color = "#657b83",
  9. header_color = "#dc322f",
  10. background_color = "#fdf6e3",
  11. link_color = "#b58900",
  12. text_bold_color = "#d33682",
  13. text_slide_number_color = "#93a1a1",
  14. padding = "16px 64px 16px 64px",
  15. background_image = NULL,
  16. background_size = NULL,
  17. background_position = NULL,
  18. code_highlight_color = "#268bd240",
  19. code_inline_color = "#6c71c4",
  20. code_inline_background_color = NULL,
  21. code_inline_font_size = "1em",
  22. inverse_background_color = "#002b36",
  23. inverse_text_color = "#fdf6e3",
  24. inverse_text_shadow = FALSE,
  25. inverse_header_color = inverse_text_color,
  26. title_slide_text_color = inverse_text_color,
  27. title_slide_background_color = inverse_background_color,
  28. title_slide_background_image = NULL,
  29. title_slide_background_size = NULL,
  30. title_slide_background_position = NULL,
  31. footnote_color = NULL,
  32. footnote_font_size = "0.9em",
  33. footnote_position_bottom = "60px",
  34. left_column_subtle_color = "#93a1a1",
  35. left_column_selected_color = "#586e75",
  36. blockquote_left_border_color = "#cb4b16",
  37. table_border_color = "#839496",
  38. table_row_border_color = "#839496",
  39. table_row_even_background_color = "#eee8d5",
  40. base_font_size = "20px",
  41. text_font_size = "1rem",
  42. header_h1_font_size = "2.75rem",
  43. header_h2_font_size = "2.25rem",
  44. header_h3_font_size = "1.75rem",
  45. header_background_auto = FALSE,
  46. header_background_color = header_color,
  47. header_background_text_color = background_color,
  48. header_background_padding = NULL,
  49. header_background_content_padding_top = "7rem",
  50. header_background_ignore_classes = c("normal", "inverse", "title", "middle", "bottom"),
  51. text_slide_number_font_size = "0.9em",
  52. text_font_google = NULL,
  53. text_font_family = "Noto Sans",
  54. text_font_weight = "normal",
  55. text_font_url = "https://fonts.googleapis.com/css?family=Noto+Sans:400,400i,700,700i&display=swap",
  56. text_font_family_fallback = "-apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue, helvetica, Ubuntu, roboto, noto, segoe ui, arial",
  57. text_font_base = "sans-serif",
  58. header_font_google = NULL,
  59. header_font_family = "Cabin",
  60. header_font_weight = "600",
  61. header_font_url = "https://fonts.googleapis.com/css?family=Cabin:600,600i&display=swap",
  62. code_font_google = NULL,
  63. code_font_family = "Source Code Pro",
  64. code_font_size = "0.9rem",
  65. code_font_url = "https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap",
  66. code_font_family_fallback = "Menlo, Consolas, Monaco, Liberation Mono, Lucida Console",
  67. colors = NULL,
  68. extra_css = NULL,
  69. extra_fonts = NULL,
  70. outfile = "xaringan-themer.css"
  71. )
  72. }
  73. \arguments{
  74. \item{text_color}{Text Color. Defaults to #657b83. Modifies the \code{body}
  75. element. The value of this variable is also stored as a CSS variable that
  76. can be referenced with \code{var(--text_color)} in any argument of a style
  77. function or in custom CSS.}
  78. \item{header_color}{Header Color. Defaults to #dc322f. Modifies the
  79. \verb{h1, h2, h3} elements. The value of this variable is also stored as a CSS
  80. variable that can be referenced with \code{var(--header-color)} in any argument
  81. of a style function or in custom CSS.}
  82. \item{background_color}{Slide Background Color. Defaults to #fdf6e3.
  83. Modifies the \code{.remark-slide-content} class. The value of this variable is
  84. also stored as a CSS variable that can be referenced with
  85. \code{var(--background-color)} in any argument of a style function or in custom
  86. CSS.}
  87. \item{link_color}{Link Color. Defaults to #b58900. Modifies the
  88. \verb{a, a > code} elements. The value of this variable is also stored as a CSS
  89. variable that can be referenced with \code{var(--link-color)} in any argument
  90. of a style function or in custom CSS.}
  91. \item{text_bold_color}{Bold Text Color. Defaults to #d33682. Modifies the
  92. \code{strong} element. The value of this variable is also stored as a CSS
  93. variable that can be referenced with \code{var(--text-bold-color)} in any
  94. argument of a style function or in custom CSS.}
  95. \item{text_slide_number_color}{Slide Number Color. Defaults to #93a1a1.
  96. Modifies the \code{.remark-slide-number} class.}
  97. \item{padding}{Slide Padding in \verb{top right [bottom left]} format. Defaults
  98. to 16px 64px 16px 64px. Modifies the \code{.remark-slide-content} class.}
  99. \item{background_image}{Background image applied to each \emph{and every} slide.
  100. Set \code{title_slide_background_image = "none"} to remove the background image
  101. from the title slide. Defaults to \code{NULL}. Modifies the
  102. \code{.remark-slide-content} class.}
  103. \item{background_size}{Background image size, requires \code{background_image} to
  104. be set. If \code{background_image} is set, \code{background_size} will default to
  105. \code{cover} so the backround fills the screen. If both \code{background_image} and
  106. \code{background_position} are set, will default to 100 percent. Defaults to
  107. \code{NULL}. Modifies the \code{.remark-slide-content} class.}
  108. \item{background_position}{Background image position, requires
  109. \code{background_image} to be set, and it is recommended to adjust
  110. \code{background_size}. Defaults to \code{NULL}. Modifies the
  111. \code{.remark-slide-content} class.}
  112. \item{code_highlight_color}{Code Line Highlight. Defaults to #268bd240.
  113. Modifies the \code{.remark-code-line-highlighted} class. The value of this
  114. variable is also stored as a CSS variable that can be referenced with
  115. \code{var(--code-highlight-color)} in any argument of a style function or in
  116. custom CSS.}
  117. \item{code_inline_color}{Inline Code Color. Defaults to #6c71c4. Modifies
  118. the \code{.remark-inline-code} class.}
  119. \item{code_inline_background_color}{Inline Code Background Color. Defaults
  120. to \code{NULL}. Modifies the \code{.remark-inline-code} class.}
  121. \item{code_inline_font_size}{Inline Code Text Font Size. Defaults to 1em.
  122. Modifies the \code{.remark-inline-code} class. The value of this variable is
  123. also stored as a CSS variable that can be referenced with
  124. \code{var(--code-inline-font-size)} in any argument of a style function or in
  125. custom CSS.}
  126. \item{inverse_background_color}{Inverse Background Color. Defaults to
  127. #002b36. Modifies the \code{.inverse} class. The value of this variable is also
  128. stored as a CSS variable that can be referenced with
  129. \code{var(--inverse-background-color)} in any argument of a style function or
  130. in custom CSS.}
  131. \item{inverse_text_color}{Inverse Text Color. Defaults to #fdf6e3. Modifies
  132. the \code{.inverse} class. The value of this variable is also stored as a CSS
  133. variable that can be referenced with \code{var(--inverse-text-color)} in any
  134. argument of a style function or in custom CSS.}
  135. \item{inverse_text_shadow}{Enables Shadow on text of inverse slides.
  136. Defaults to \code{FALSE}. Modifies the \code{.inverse} class.}
  137. \item{inverse_header_color}{Inverse Header Color. Defaults to
  138. \code{inverse_text_color}. Modifies the \verb{.inverse h1, .inverse h2, .inverse h3}
  139. classes. The value of this variable is also stored as a CSS variable that
  140. can be referenced with \code{var(--inverse-header-color)} in any argument of a
  141. style function or in custom CSS.}
  142. \item{title_slide_text_color}{Title Slide Text Color. Defaults to
  143. \code{inverse_text_color}. Modifies the \code{.title-slide} class. The value of this
  144. variable is also stored as a CSS variable that can be referenced with
  145. \code{var(--title-slide-text-color)} in any argument of a style function or in
  146. custom CSS.}
  147. \item{title_slide_background_color}{Title Slide Background Color. Defaults
  148. to \code{inverse_background_color}. Modifies the \code{.title-slide} class. The
  149. value of this variable is also stored as a CSS variable that can be
  150. referenced with \code{var(--title-slide-background-color)} in any argument of a
  151. style function or in custom CSS.}
  152. \item{title_slide_background_image}{Title Slide Background Image URL.
  153. Defaults to \code{NULL}. Modifies the \code{.title-slide} class.}
  154. \item{title_slide_background_size}{Title Slide Background Image Size,
  155. defaults to "cover" if background image is set. Defaults to \code{NULL}.
  156. Modifies the \code{.title-slide} class.}
  157. \item{title_slide_background_position}{Title Slide Background Image
  158. Position. Defaults to \code{NULL}. Modifies the \code{.title-slide} class.}
  159. \item{footnote_color}{Footnote text color (if \code{NA}, then it will be the same
  160. color as \code{text_color}). Defaults to \code{NULL}. Modifies the \code{.footnote}
  161. class.}
  162. \item{footnote_font_size}{Footnote font size. Defaults to 0.9em. Modifies
  163. the \code{.footnote} class.}
  164. \item{footnote_position_bottom}{Footnote location from bottom of screen.
  165. Defaults to 60px. Modifies the \code{.footnote} class.}
  166. \item{left_column_subtle_color}{Left Column Text (not last). Defaults to
  167. #93a1a1. Modifies the \verb{.left-column h2, .left-column h3} classes.}
  168. \item{left_column_selected_color}{Left Column Current Selection. Defaults to
  169. #586e75. Modifies the
  170. \verb{.left-column h2:last-of-type, .left-column h3:last-child} classes.}
  171. \item{blockquote_left_border_color}{Blockquote Left Border Color. Defaults
  172. to #cb4b16. Modifies the \code{blockquote} element.}
  173. \item{table_border_color}{Table top/bottom border. Defaults to #839496.
  174. Modifies the \verb{table: border-top, border-bottom} elements.}
  175. \item{table_row_border_color}{Table row inner bottom border. Defaults to
  176. #839496. Modifies the \verb{table thead th: border-bottom} elements.}
  177. \item{table_row_even_background_color}{Table Even Row Background Color.
  178. Defaults to #eee8d5. Modifies the \verb{thead, tfoot, tr:nth-child(even)}
  179. elements.}
  180. \item{base_font_size}{Base Font Size for All Slide Elements (must be \code{px}).
  181. Defaults to 20px. Modifies the \code{html} element. The value of this variable
  182. is also stored as a CSS variable that can be referenced with
  183. \code{var(--base-font-size)} in any argument of a style function or in custom
  184. CSS.}
  185. \item{text_font_size}{Slide Body Text Font Size. Defaults to 1rem. Modifies
  186. the \code{.remark-slide-content} class. The value of this variable is also
  187. stored as a CSS variable that can be referenced with
  188. \code{var(--text-font-size)} in any argument of a style function or in custom
  189. CSS.}
  190. \item{header_h1_font_size}{h1 Header Text Font Size. Defaults to 2.75rem.
  191. Modifies the \verb{.remark-slide-content h1} class. The value of this variable
  192. is also stored as a CSS variable that can be referenced with
  193. \code{var(--header-h1-font-size)} in any argument of a style function or in
  194. custom CSS.}
  195. \item{header_h2_font_size}{h2 Header Text Font Size. Defaults to 2.25rem.
  196. Modifies the \verb{.remark-slide-content h2} class. The value of this variable
  197. is also stored as a CSS variable that can be referenced with
  198. \code{var(--header-h2-font-size)} in any argument of a style function or in
  199. custom CSS.}
  200. \item{header_h3_font_size}{h3 Header Text Font Size. Defaults to 1.75rem.
  201. Modifies the \verb{.remark-slide-content h3} class. The value of this variable
  202. is also stored as a CSS variable that can be referenced with
  203. \code{var(--header-h3-font-size)} in any argument of a style function or in
  204. custom CSS.}
  205. \item{header_background_auto}{Add background under slide title automatically
  206. for h1 header elements. If not enabled, use \code{class: header_background} to
  207. enable. Defaults to \code{FALSE}.}
  208. \item{header_background_color}{Background Color for h1 Header with
  209. Background. Defaults to \code{header_color}. Modifies the
  210. \verb{.remark-slide-content h1} class. The value of this variable is also
  211. stored as a CSS variable that can be referenced with
  212. \code{var(--header-background-color)} in any argument of a style function or in
  213. custom CSS.}
  214. \item{header_background_text_color}{Text Color for h1 Header with
  215. Background. Defaults to \code{background_color}. Modifies the
  216. \verb{.remark-slide-content h1} class. The value of this variable is also
  217. stored as a CSS variable that can be referenced with
  218. \code{var(--header-background-text-color)} in any argument of a style function
  219. or in custom CSS.}
  220. \item{header_background_padding}{Padding for h1 Header with Background.
  221. Defaults to \code{NULL}. Modifies the \verb{.remark-slide-content h1} class.}
  222. \item{header_background_content_padding_top}{Top Padding for Content in
  223. Slide with Header with Background. Defaults to 7rem. Modifies the
  224. \code{.remark-slide-content} class.}
  225. \item{header_background_ignore_classes}{Slide Classes Where Header with
  226. Background will not be Applied. Defaults to
  227. \code{c('normal', 'inverse', 'title', 'middle', 'bottom')}. Modifies the
  228. \code{.remark-slide-content} class.}
  229. \item{text_slide_number_font_size}{Slide Number Text Font Size. Defaults to
  230. 0.9em. Modifies the \code{.remark-slide-number} class.}
  231. \item{text_font_google}{Use \code{google_font()} to specify body font. Defaults
  232. to \code{NULL}. Modifies the \code{body} element.}
  233. \item{text_font_family}{Body Text Font Family (xaringan default is
  234. \code{'Droid Serif'}). Defaults to Noto Sans. Modifies the \code{body} element. The
  235. value of this variable is also stored as a CSS variable that can be
  236. referenced with \code{var(--text-font-family)} in any argument of a style
  237. function or in custom CSS.}
  238. \item{text_font_weight}{Body Text Font Weight. Defaults to normal. Modifies
  239. the \code{body} element.}
  240. \item{text_font_url}{Body Text Font URL(s). Defaults to
  241. https://fonts.googleapis.com/css?family=Noto+Sans:400,400i,700,700i&display=swap.
  242. Modifies the \verb{@import url()} elements.}
  243. \item{text_font_family_fallback}{Body Text Font Fallbacks. Defaults to
  244. -apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue,
  245. helvetica, Ubuntu, roboto, noto, segoe ui, arial. Modifies the \code{body}
  246. element. The value of this variable is also stored as a CSS variable that
  247. can be referenced with \code{var(--text-font-family-fallback)} in any argument
  248. of a style function or in custom CSS.}
  249. \item{text_font_base}{Body Text Base Font (Total Failure Fallback). Defaults
  250. to sans-serif. Modifies the \code{body} element. The value of this variable is
  251. also stored as a CSS variable that can be referenced with
  252. \code{var(--text-font-base)} in any argument of a style function or in custom
  253. CSS.}
  254. \item{header_font_google}{Use \code{google_font()} to specify header font.
  255. Defaults to \code{NULL}. Modifies the \code{body} element.}
  256. \item{header_font_family}{Header Font Family (xaringan default is
  257. \code{'Yanone Kaffeesatz'}). Defaults to Cabin. Modifies the \verb{h1, h2, h3}
  258. elements. The value of this variable is also stored as a CSS variable that
  259. can be referenced with \code{var(--header-font-family)} in any argument of a
  260. style function or in custom CSS.}
  261. \item{header_font_weight}{Header Font Weight. Defaults to 600. Modifies the
  262. \verb{h1, h2, h3} elements.}
  263. \item{header_font_url}{Header Font URL. Defaults to
  264. https://fonts.googleapis.com/css?family=Cabin:600,600i&display=swap.
  265. Modifies the \verb{@import url} elements.}
  266. \item{code_font_google}{Use \code{google_font()} to specify code font. Defaults
  267. to \code{NULL}. Modifies the \code{body} element.}
  268. \item{code_font_family}{Code Font Family. Defaults to Source Code Pro.
  269. Modifies the \verb{.remark-code, .remark-inline-code} classes. The value of
  270. this variable is also stored as a CSS variable that can be referenced with
  271. \code{var(--code-font-family)} in any argument of a style function or in custom
  272. CSS.}
  273. \item{code_font_size}{Code Text Font Size. Defaults to 0.9rem. Modifies the
  274. \code{.remark-inline} class. The value of this variable is also stored as a CSS
  275. variable that can be referenced with \code{var(--code-font-size)} in any
  276. argument of a style function or in custom CSS.}
  277. \item{code_font_url}{Code Font URL. Defaults to
  278. https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap.
  279. Modifies the \verb{@import url} elements.}
  280. \item{code_font_family_fallback}{Code Font Fallback. Defaults to Menlo,
  281. Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
  282. \verb{.remark-code, .remark-inline-code} classes.}
  283. \item{colors}{A named vector of custom colors. The names of the colors
  284. become CSS variables and classes that can be used within your slides.
  285. For example, \code{colors = c(blue = "#bad4ed")} adds a CSS variable
  286. \code{--blue}, a \code{.blue} CSS class that applies the color to the text or
  287. foreground color, and a \code{.bg-blue} CSS class that applies the color
  288. to the background.}
  289. \item{extra_css}{A named list of CSS definitions each containing a named list
  290. of CSS property-value pairs, i.e.
  291. \code{list(".class-id" = list("css-property" = "value"))}.}
  292. \item{extra_fonts}{A list of additional fonts to import, each list element
  293. can be either a URL as a character string or a call to
  294. \code{\link{google_font}()}. To use a font imported in \code{extra_fonts}, you
  295. will need to write custom CSS rules that apply the font to an element or
  296. class with the \code{font-family} property. See the \strong{Fonts} section of
  297. \code{vignette("xaringanthemer")} for an example.}
  298. \item{outfile}{Customized xaringan CSS output file name, default is "xaringan-themer.css"}
  299. }
  300. \description{
  301. A light theme based around on the solarized color scheme.
  302. Works well with "\code{highlightStyle: solarized-dark}" or
  303. "\code{highlighStyle: solarized-light}".
  304. }
  305. \section{Usage}{
  306. To use the styles created by this theme function, make sure
  307. that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
  308. header. If you change the name of the output file using the \code{outfile}
  309. argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
  310. xaringan::moon_reader:
  311. css: xaringan-themer.css`
  312. }\if{html}{\out{</div>}}
  313. }
  314. \examples{
  315. # Create a xaringan style in a temporary file
  316. xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
  317. style_solarized_light(
  318. outfile = xaringan_themer_css # omit in your slides to write the
  319. # styles to xaringan-themer.css
  320. )
  321. # View the CSS:
  322. # file.edit(xaringan_themer_css)
  323. }
  324. \references{
  325. \url{http://ethanschoonover.com/solarized}
  326. }
  327. \seealso{
  328. Other themes:
  329. \code{\link{style_duo_accent_inverse}()},
  330. \code{\link{style_duo_accent}()},
  331. \code{\link{style_duo}()},
  332. \code{\link{style_mono_accent_inverse}()},
  333. \code{\link{style_mono_accent}()},
  334. \code{\link{style_mono_dark}()},
  335. \code{\link{style_mono_light}()},
  336. \code{\link{style_solarized_dark}()},
  337. \code{\link{style_xaringan}()}
  338. Other Solarized themes:
  339. \code{\link{style_solarized_dark}()}
  340. }
  341. \concept{Solarized themes}
  342. \concept{themes}