😎 Give your xaringan slides some style
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

468 lines
21KB

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