😎 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.

444 lines
20KB

  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. Accepts CSS
  100. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/padding}{padding}
  101. property values.}
  102. \item{background_image}{Background image applied to each \emph{and every} slide.
  103. Set \code{title_slide_background_image = "none"} to remove the background image
  104. from the title slide. Defaults to \code{NULL}. Modifies the
  105. \code{.remark-slide-content} class.}
  106. \item{background_size}{Background image size, requires \code{background_image} to
  107. be set. If \code{background_image} is set, \code{background_size} will default to
  108. \code{cover} so the backround fills the screen. If both \code{background_image} and
  109. \code{background_position} are set, will default to 100 percent. Defaults to
  110. \code{NULL}. Modifies the \code{.remark-slide-content} class. Accepts CSS
  111. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/background-size}{background-size}
  112. property values.}
  113. \item{background_position}{Background image position, requires
  114. \code{background_image} to be set, and it is recommended to adjust
  115. \code{background_size}. Defaults to \code{NULL}. Modifies the
  116. \code{.remark-slide-content} class. Accepts CSS
  117. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/background-position}{background-position}
  118. property values.}
  119. \item{code_highlight_color}{Code Line Highlight. Defaults to #268bd240.
  120. Modifies the \code{.remark-code-line-highlighted} class. The value of this
  121. variable is also stored as a CSS variable that can be referenced with
  122. \code{var(--code-highlight-color)} in any argument of a style function or in
  123. custom CSS.}
  124. \item{code_inline_color}{Inline Code Color. Defaults to #6c71c4. Modifies
  125. the \code{.remark-inline-code} class.}
  126. \item{code_inline_background_color}{Inline Code Background Color. Defaults
  127. to \code{NULL}. Modifies the \code{.remark-inline-code} class.}
  128. \item{code_inline_font_size}{Inline Code Text Font Size. Defaults to 1em.
  129. Modifies the \code{.remark-inline-code} class. Accepts CSS
  130. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-size}{font-size}
  131. property values. The value of this variable is also stored as a CSS
  132. variable that can be referenced with \code{var(--code-inline-font-size)} in any
  133. argument of a style function or in custom CSS.}
  134. \item{inverse_background_color}{Inverse Background Color. Defaults to
  135. #002b36. Modifies the \code{.inverse} class. The value of this variable is also
  136. stored as a CSS variable that can be referenced with
  137. \code{var(--inverse-background-color)} in any argument of a style function or
  138. in custom CSS.}
  139. \item{inverse_text_color}{Inverse Text Color. Defaults to #fdf6e3. Modifies
  140. the \code{.inverse} class. The value of this variable is also stored as a CSS
  141. variable that can be referenced with \code{var(--inverse-text-color)} in any
  142. argument of a style function or in custom CSS.}
  143. \item{inverse_text_shadow}{Enables Shadow on text of inverse slides.
  144. Defaults to \code{FALSE}. Modifies the \code{.inverse} class.}
  145. \item{inverse_header_color}{Inverse Header Color. Defaults to
  146. \code{inverse_text_color}. Modifies the \verb{.inverse h1, .inverse h2, .inverse h3}
  147. classes. The value of this variable is also stored as a CSS variable that
  148. can be referenced with \code{var(--inverse-header-color)} in any argument of a
  149. style function or in custom CSS.}
  150. \item{title_slide_text_color}{Title Slide Text Color. Defaults to
  151. \code{inverse_text_color}. Modifies the \code{.title-slide} class. The value of this
  152. variable is also stored as a CSS variable that can be referenced with
  153. \code{var(--title-slide-text-color)} in any argument of a style function or in
  154. custom CSS.}
  155. \item{title_slide_background_color}{Title Slide Background Color. Defaults
  156. to \code{inverse_background_color}. Modifies the \code{.title-slide} class. The
  157. value of this variable is also stored as a CSS variable that can be
  158. referenced with \code{var(--title-slide-background-color)} in any argument of a
  159. style function or in custom CSS.}
  160. \item{title_slide_background_image}{Title Slide Background Image URL.
  161. Defaults to \code{NULL}. Modifies the \code{.title-slide} class.}
  162. \item{title_slide_background_size}{Title Slide Background Image Size,
  163. defaults to "cover" if background image is set. Defaults to \code{NULL}.
  164. Modifies the \code{.title-slide} class. Accepts CSS
  165. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/background-size}{background-size}
  166. property values.}
  167. \item{title_slide_background_position}{Title Slide Background Image
  168. Position. Defaults to \code{NULL}. Modifies the \code{.title-slide} class. Accepts
  169. CSS
  170. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/background-position}{background-position}
  171. property values.}
  172. \item{footnote_color}{Footnote text color (if \code{NA}, then it will be the same
  173. color as \code{text_color}). Defaults to \code{NULL}. Modifies the \code{.footnote}
  174. class.}
  175. \item{footnote_font_size}{Footnote font size. Defaults to 0.9em. Modifies
  176. the \code{.footnote} class. Accepts CSS
  177. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-size}{font-size}
  178. property values.}
  179. \item{footnote_position_bottom}{Footnote location from bottom of screen.
  180. Defaults to 60px. Modifies the \code{.footnote} class. Accepts CSS
  181. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/position_value}{position}
  182. property values.}
  183. \item{left_column_subtle_color}{Left Column Text (not last). Defaults to
  184. #93a1a1. Modifies the \verb{.left-column h2, .left-column h3} classes.}
  185. \item{left_column_selected_color}{Left Column Current Selection. Defaults to
  186. #586e75. Modifies the
  187. \verb{.left-column h2:last-of-type, .left-column h3:last-child} classes.}
  188. \item{blockquote_left_border_color}{Blockquote Left Border Color. Defaults
  189. to #cb4b16. Modifies the \code{blockquote} element.}
  190. \item{table_border_color}{Table top/bottom border. Defaults to #839496.
  191. Modifies the \verb{table: border-top, border-bottom} elements.}
  192. \item{table_row_border_color}{Table row inner bottom border. Defaults to
  193. #839496. Modifies the \verb{table thead th: border-bottom} elements.}
  194. \item{table_row_even_background_color}{Table Even Row Background Color.
  195. Defaults to #eee8d5. Modifies the \verb{thead, tfoot, tr:nth-child(even)}
  196. elements.}
  197. \item{base_font_size}{Base Font Size for All Slide Elements (must be \code{px}).
  198. Defaults to 20px. Modifies the \code{html} element. The value of this variable
  199. is also stored as a CSS variable that can be referenced with
  200. \code{var(--base-font-size)} in any argument of a style function or in custom
  201. CSS.}
  202. \item{text_font_size}{Slide Body Text Font Size. Defaults to 1rem. Modifies
  203. the \code{.remark-slide-content} class. Accepts CSS
  204. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-size}{font-size}
  205. property values. The value of this variable is also stored as a CSS
  206. variable that can be referenced with \code{var(--text-font-size)} in any
  207. argument of a style function or in custom CSS.}
  208. \item{header_h1_font_size}{h1 Header Text Font Size. Defaults to 2.75rem.
  209. Modifies the \verb{.remark-slide-content h1} class. Accepts CSS
  210. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-size}{font-size}
  211. property values. The value of this variable is also stored as a CSS
  212. variable that can be referenced with \code{var(--header-h1-font-size)} in any
  213. argument of a style function or in custom CSS.}
  214. \item{header_h2_font_size}{h2 Header Text Font Size. Defaults to 2.25rem.
  215. Modifies the \verb{.remark-slide-content h2} class. Accepts CSS
  216. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-size}{font-size}
  217. property values. The value of this variable is also stored as a CSS
  218. variable that can be referenced with \code{var(--header-h2-font-size)} in any
  219. argument of a style function or in custom CSS.}
  220. \item{header_h3_font_size}{h3 Header Text Font Size. Defaults to 1.75rem.
  221. Modifies the \verb{.remark-slide-content h3} class. Accepts CSS
  222. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-size}{font-size}
  223. property values. The value of this variable is also stored as a CSS
  224. variable that can be referenced with \code{var(--header-h3-font-size)} in any
  225. argument of a style function or in custom CSS.}
  226. \item{header_background_auto}{Add background under slide title automatically
  227. for h1 header elements. If not enabled, use \code{class: header_background} to
  228. enable. Defaults to \code{FALSE}.}
  229. \item{header_background_color}{Background Color for h1 Header with
  230. Background. Defaults to \code{header_color}. Modifies the
  231. \verb{.remark-slide-content h1} class. The value of this variable is also
  232. stored as a CSS variable that can be referenced with
  233. \code{var(--header-background-color)} in any argument of a style function or in
  234. custom CSS.}
  235. \item{header_background_text_color}{Text Color for h1 Header with
  236. Background. Defaults to \code{background_color}. Modifies the
  237. \verb{.remark-slide-content h1} class. The value of this variable is also
  238. stored as a CSS variable that can be referenced with
  239. \code{var(--header-background-text-color)} in any argument of a style function
  240. or in custom CSS.}
  241. \item{header_background_padding}{Padding for h1 Header with Background.
  242. Defaults to \code{NULL}. Modifies the \verb{.remark-slide-content h1} class. Accepts
  243. CSS \href{https://developer.mozilla.org/en-US/docs/Web/CSS/padding}{padding}
  244. property values.}
  245. \item{header_background_content_padding_top}{Top Padding for Content in
  246. Slide with Header with Background. Defaults to 7rem. Modifies the
  247. \code{.remark-slide-content} class.}
  248. \item{header_background_ignore_classes}{Slide Classes Where Header with
  249. Background will not be Applied. Defaults to
  250. \code{c('normal', 'inverse', 'title', 'middle', 'bottom')}. Modifies the
  251. \code{.remark-slide-content} class.}
  252. \item{text_slide_number_font_size}{Slide Number Text Font Size. Defaults to
  253. 0.9em. Modifies the \code{.remark-slide-number} class. Accepts CSS
  254. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-size}{font-size}
  255. property values.}
  256. \item{text_font_google}{Use \code{google_font()} to specify body font. Defaults
  257. to \code{NULL}. Modifies the \code{body} element.}
  258. \item{text_font_family}{Body Text Font Family (xaringan default is
  259. \code{'Droid Serif'}). Defaults to Noto Sans. Modifies the \code{body} element. The
  260. value of this variable is also stored as a CSS variable that can be
  261. referenced with \code{var(--text-font-family)} in any argument of a style
  262. function or in custom CSS.}
  263. \item{text_font_weight}{Body Text Font Weight. Defaults to normal. Modifies
  264. the \code{body} element. Accepts CSS
  265. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight}{font-weight}
  266. property values.}
  267. \item{text_font_url}{Body Text Font URL(s). Defaults to
  268. https://fonts.googleapis.com/css?family=Noto+Sans:400,400i,700,700i&display=swap.
  269. Modifies the \verb{@import url()} elements.}
  270. \item{text_font_family_fallback}{Body Text Font Fallbacks. Defaults to
  271. -apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue,
  272. helvetica, Ubuntu, roboto, noto, segoe ui, arial. Modifies the \code{body}
  273. element. The value of this variable is also stored as a CSS variable that
  274. can be referenced with \code{var(--text-font-family-fallback)} in any argument
  275. of a style function or in custom CSS.}
  276. \item{text_font_base}{Body Text Base Font (Total Failure Fallback). Defaults
  277. to sans-serif. Modifies the \code{body} element. The value of this variable is
  278. also stored as a CSS variable that can be referenced with
  279. \code{var(--text-font-base)} in any argument of a style function or in custom
  280. CSS.}
  281. \item{header_font_google}{Use \code{google_font()} to specify header font.
  282. Defaults to \code{NULL}. Modifies the \code{body} element.}
  283. \item{header_font_family}{Header Font Family (xaringan default is
  284. \code{'Yanone Kaffeesatz'}). Defaults to Cabin. Modifies the \verb{h1, h2, h3}
  285. elements. The value of this variable is also stored as a CSS variable that
  286. can be referenced with \code{var(--header-font-family)} in any argument of a
  287. style function or in custom CSS.}
  288. \item{header_font_weight}{Header Font Weight. Defaults to 600. Modifies the
  289. \verb{h1, h2, h3} elements. Accepts CSS
  290. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight}{font-weight}
  291. property values.}
  292. \item{header_font_url}{Header Font URL. Defaults to
  293. https://fonts.googleapis.com/css?family=Cabin:600,600i&display=swap.
  294. Modifies the \verb{@import url} elements.}
  295. \item{code_font_google}{Use \code{google_font()} to specify code font. Defaults
  296. to \code{NULL}. Modifies the \code{body} element.}
  297. \item{code_font_family}{Code Font Family. Defaults to Source Code Pro.
  298. Modifies the \verb{.remark-code, .remark-inline-code} classes. The value of
  299. this variable is also stored as a CSS variable that can be referenced with
  300. \code{var(--code-font-family)} in any argument of a style function or in custom
  301. CSS.}
  302. \item{code_font_size}{Code Text Font Size. Defaults to 0.9rem. Modifies the
  303. \code{.remark-inline} class. Accepts CSS
  304. \href{https://developer.mozilla.org/en-US/docs/Web/CSS/font-size}{font-size}
  305. property values. The value of this variable is also stored as a CSS
  306. variable that can be referenced with \code{var(--code-font-size)} in any
  307. argument of a style function or in custom CSS.}
  308. \item{code_font_url}{Code Font URL. Defaults to
  309. https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap.
  310. Modifies the \verb{@import url} elements.}
  311. \item{code_font_family_fallback}{Code Font Fallback. Defaults to Menlo,
  312. Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
  313. \verb{.remark-code, .remark-inline-code} classes.}
  314. \item{colors}{A named vector of custom colors. The names of the colors
  315. become CSS variables and classes that can be used within your slides.
  316. For example, \code{colors = c(blue = "#bad4ed")} adds a CSS variable
  317. \code{--blue}, a \code{.blue} CSS class that applies the color to the text or
  318. foreground color, and a \code{.bg-blue} CSS class that applies the color
  319. to the background.}
  320. \item{extra_css}{A named list of CSS definitions each containing a named list
  321. of CSS property-value pairs, i.e.
  322. \code{list(".class-id" = list("css-property" = "value"))}.}
  323. \item{extra_fonts}{A list of additional fonts to import, each list element
  324. can be either a URL as a character string or a call to
  325. \code{\link{google_font}()}. To use a font imported in \code{extra_fonts}, you
  326. will need to write custom CSS rules that apply the font to an element or
  327. class with the \code{font-family} property. See the \strong{Fonts} section of
  328. \code{vignette("xaringanthemer")} for an example.}
  329. \item{outfile}{Customized xaringan CSS output file name, default is "xaringan-themer.css"}
  330. }
  331. \description{
  332. A light theme based around on the solarized color scheme.
  333. Works well with "\code{highlightStyle: solarized-dark}" or
  334. "\code{highlighStyle: solarized-light}".
  335. }
  336. \section{Usage}{
  337. To use the styles created by this theme function, make sure
  338. that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
  339. header. If you change the name of the output file using the \code{outfile}
  340. argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
  341. xaringan::moon_reader:
  342. css: xaringan-themer.css
  343. }\if{html}{\out{</div>}}
  344. }
  345. \examples{
  346. # Create a xaringan style in a temporary file
  347. xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
  348. style_solarized_light(
  349. outfile = xaringan_themer_css # omit in your slides to write the
  350. # styles to xaringan-themer.css
  351. )
  352. # View the CSS:
  353. # file.edit(xaringan_themer_css)
  354. }
  355. \references{
  356. \url{http://ethanschoonover.com/solarized}
  357. }
  358. \seealso{
  359. Other themes:
  360. \code{\link{style_duo_accent_inverse}()},
  361. \code{\link{style_duo_accent}()},
  362. \code{\link{style_duo}()},
  363. \code{\link{style_mono_accent_inverse}()},
  364. \code{\link{style_mono_accent}()},
  365. \code{\link{style_mono_dark}()},
  366. \code{\link{style_mono_light}()},
  367. \code{\link{style_solarized_dark}()},
  368. \code{\link{style_xaringan}()}
  369. Other Solarized themes:
  370. \code{\link{style_solarized_dark}()}
  371. }
  372. \concept{Solarized themes}
  373. \concept{themes}