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

463 lines
23KB

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