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

426 lines
19KB

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