😎 Give your xaringan slides some style
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.

747 lines
38KB

  1. <!-- Generated by pkgdown: do not edit by hand -->
  2. <!DOCTYPE html>
  3. <html lang="en">
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>Write A Customized Xaringan Theme — xaringanthemer_font_default • xaringanthemer</title>
  9. <!-- jquery -->
  10. <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
  11. <!-- Bootstrap -->
  12. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />
  13. <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
  14. <!-- bootstrap-toc -->
  15. <link rel="stylesheet" href="../bootstrap-toc.css">
  16. <script src="../bootstrap-toc.js"></script>
  17. <!-- Font Awesome icons -->
  18. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
  19. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
  20. <!-- clipboard.js -->
  21. <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
  22. <!-- headroom.js -->
  23. <script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
  24. <script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
  25. <!-- pkgdown -->
  26. <link href="../pkgdown.css" rel="stylesheet">
  27. <script src="../pkgdown.js"></script>
  28. <link href="../extra.css" rel="stylesheet">
  29. <meta property="og:title" content="Write A Customized Xaringan Theme — xaringanthemer_font_default" />
  30. <meta property="og:description" content="Creates a customized Xaringan theme CSS file." />
  31. <meta name="twitter:card" content="summary" />
  32. <meta name="twitter:creator" content="@grrrck" />
  33. <meta name="twitter:site" content="@grrrck" />
  34. <!-- mathjax -->
  35. <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
  36. <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
  37. <!--[if lt IE 9]>
  38. <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
  39. <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  40. <![endif]-->
  41. </head>
  42. <body data-spy="scroll" data-target="#toc">
  43. <div class="container template-reference-topic">
  44. <header>
  45. <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  46. <div class="container">
  47. <div class="navbar-header">
  48. <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
  49. <span class="sr-only">Toggle navigation</span>
  50. <span class="icon-bar"></span>
  51. <span class="icon-bar"></span>
  52. <span class="icon-bar"></span>
  53. </button>
  54. <span class="navbar-brand">
  55. <a class="navbar-link" href="../index.html">xaringanthemer</a>
  56. <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.2.0.9100</span>
  57. </span>
  58. </div>
  59. <div id="navbar" class="navbar-collapse collapse">
  60. <ul class="nav navbar-nav">
  61. <li>
  62. <a href="../articles/xaringanthemer.html">Features</a>
  63. </li>
  64. <li>
  65. <a href="../reference/index.html">Reference</a>
  66. </li>
  67. <li>
  68. <a href="../articles/themes.html">Themes</a>
  69. </li>
  70. <li>
  71. <a href="../articles/fonts.html">Fonts</a>
  72. </li>
  73. <li>
  74. <a href="../articles/template-variables.html">Template Variables</a>
  75. </li>
  76. </ul>
  77. <ul class="nav navbar-nav navbar-right">
  78. <li>
  79. <a href="../news/index.html">
  80. <span class="fa fa fa fa-newspaper-o fa-lg"></span>
  81. </a>
  82. </li>
  83. <li>
  84. <a href="https://github.com/gadenbuie/xaringanthemer">
  85. <span class="fa fa-github fa-lg"></span>
  86. </a>
  87. </li>
  88. <li>
  89. <a href="https://twitter.com/grrrck">
  90. <span class="fa fa-twitter fa-lg"></span>
  91. </a>
  92. </li>
  93. <li>
  94. <a href="https://www.garrickadenbuie.com">
  95. <span class="fa fa-home fa-lg"></span>
  96. </a>
  97. </li>
  98. </ul>
  99. </div><!--/.nav-collapse -->
  100. </div><!--/.container -->
  101. </div><!--/.navbar -->
  102. </header>
  103. <div class="row">
  104. <div class="col-md-9 contents">
  105. <div class="page-header">
  106. <h1>Write A Customized Xaringan Theme</h1>
  107. <small class="dont-index">Source: <a href='https://github.com/gadenbuie/xaringanthemer/blob/master/R/style_font_default.R'><code>R/style_font_default.R</code></a>, <a href='https://github.com/gadenbuie/xaringanthemer/blob/master/R/style_xaringan.R'><code>R/style_xaringan.R</code></a></small>
  108. <div class="hidden name"><code>style_xaringan.Rd</code></div>
  109. </div>
  110. <div class="ref-description">
  111. <p>Creates a customized Xaringan theme CSS file.</p>
  112. </div>
  113. <pre class="usage"><span class='fu'>xaringanthemer_font_default</span>(<span class='no'>font_arg</span>)
  114. <span class='fu'>style_xaringan</span>(
  115. <span class='kw'>text_color</span> <span class='kw'>=</span> <span class='st'>"#000"</span>,
  116. <span class='kw'>header_color</span> <span class='kw'>=</span> <span class='st'>"#000"</span>,
  117. <span class='kw'>background_color</span> <span class='kw'>=</span> <span class='st'>"#FFF"</span>,
  118. <span class='kw'>link_color</span> <span class='kw'>=</span> <span class='st'>"rgb(249, 38, 114)"</span>,
  119. <span class='kw'>text_bold_color</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  120. <span class='kw'>text_slide_number_color</span> <span class='kw'>=</span> <span class='no'>inverse_background_color</span>,
  121. <span class='kw'>padding</span> <span class='kw'>=</span> <span class='st'>"16px 64px 16px 64px"</span>,
  122. <span class='kw'>background_image</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  123. <span class='kw'>background_size</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  124. <span class='kw'>background_position</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  125. <span class='kw'>code_highlight_color</span> <span class='kw'>=</span> <span class='st'>"rgba(255,255,0,0.5)"</span>,
  126. <span class='kw'>code_inline_color</span> <span class='kw'>=</span> <span class='st'>"#000"</span>,
  127. <span class='kw'>code_inline_background_color</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  128. <span class='kw'>code_inline_font_size</span> <span class='kw'>=</span> <span class='st'>"1em"</span>,
  129. <span class='kw'>inverse_background_color</span> <span class='kw'>=</span> <span class='st'>"#272822"</span>,
  130. <span class='kw'>inverse_text_color</span> <span class='kw'>=</span> <span class='st'>"#d6d6d6"</span>,
  131. <span class='kw'>inverse_text_shadow</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>,
  132. <span class='kw'>inverse_header_color</span> <span class='kw'>=</span> <span class='st'>"#f3f3f3"</span>,
  133. <span class='kw'>title_slide_text_color</span> <span class='kw'>=</span> <span class='no'>inverse_text_color</span>,
  134. <span class='kw'>title_slide_background_color</span> <span class='kw'>=</span> <span class='no'>inverse_background_color</span>,
  135. <span class='kw'>title_slide_background_image</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  136. <span class='kw'>title_slide_background_size</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  137. <span class='kw'>title_slide_background_position</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  138. <span class='kw'>footnote_color</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  139. <span class='kw'>footnote_font_size</span> <span class='kw'>=</span> <span class='st'>"0.9em"</span>,
  140. <span class='kw'>footnote_position_bottom</span> <span class='kw'>=</span> <span class='st'>"60px"</span>,
  141. <span class='kw'>left_column_subtle_color</span> <span class='kw'>=</span> <span class='st'>"#777"</span>,
  142. <span class='kw'>left_column_selected_color</span> <span class='kw'>=</span> <span class='st'>"#000"</span>,
  143. <span class='kw'>blockquote_left_border_color</span> <span class='kw'>=</span> <span class='st'>"lightgray"</span>,
  144. <span class='kw'>table_border_color</span> <span class='kw'>=</span> <span class='st'>"#666"</span>,
  145. <span class='kw'>table_row_border_color</span> <span class='kw'>=</span> <span class='st'>"#ddd"</span>,
  146. <span class='kw'>table_row_even_background_color</span> <span class='kw'>=</span> <span class='st'>"#eee"</span>,
  147. <span class='kw'>base_font_size</span> <span class='kw'>=</span> <span class='st'>"20px"</span>,
  148. <span class='kw'>text_font_size</span> <span class='kw'>=</span> <span class='st'>"1rem"</span>,
  149. <span class='kw'>header_h1_font_size</span> <span class='kw'>=</span> <span class='st'>"2.75rem"</span>,
  150. <span class='kw'>header_h2_font_size</span> <span class='kw'>=</span> <span class='st'>"2.25rem"</span>,
  151. <span class='kw'>header_h3_font_size</span> <span class='kw'>=</span> <span class='st'>"1.75rem"</span>,
  152. <span class='kw'>header_background_auto</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>,
  153. <span class='kw'>header_background_color</span> <span class='kw'>=</span> <span class='no'>header_color</span>,
  154. <span class='kw'>header_background_text_color</span> <span class='kw'>=</span> <span class='no'>background_color</span>,
  155. <span class='kw'>header_background_padding</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  156. <span class='kw'>header_background_content_padding_top</span> <span class='kw'>=</span> <span class='st'>"7rem"</span>,
  157. <span class='kw'>header_background_ignore_classes</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"normal"</span>, <span class='st'>"inverse"</span>, <span class='st'>"title"</span>, <span class='st'>"middle"</span>, <span class='st'>"bottom"</span>),
  158. <span class='kw'>text_slide_number_font_size</span> <span class='kw'>=</span> <span class='st'>"0.9em"</span>,
  159. <span class='kw'>text_font_google</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  160. <span class='kw'>text_font_family</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"text_font_family"</span>),
  161. <span class='kw'>text_font_weight</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"text_font_weight"</span>),
  162. <span class='kw'>text_font_url</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"text_font_url"</span>),
  163. <span class='kw'>text_font_family_fallback</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"text_font_family_fallback"</span>),
  164. <span class='kw'>text_font_base</span> <span class='kw'>=</span> <span class='st'>"sans-serif"</span>,
  165. <span class='kw'>header_font_google</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  166. <span class='kw'>header_font_family</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"header_font_family"</span>),
  167. <span class='kw'>header_font_weight</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"header_font_weight"</span>),
  168. <span class='kw'>header_font_url</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"header_font_url"</span>),
  169. <span class='kw'>code_font_google</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  170. <span class='kw'>code_font_family</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"code_font_family"</span>),
  171. <span class='kw'>code_font_size</span> <span class='kw'>=</span> <span class='st'>"0.9rem"</span>,
  172. <span class='kw'>code_font_url</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"code_font_url"</span>),
  173. <span class='kw'>code_font_family_fallback</span> <span class='kw'>=</span> <span class='fu'>xaringanthemer_font_default</span>(<span class='st'>"code_font_family_fallback"</span>),
  174. <span class='kw'>colors</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  175. <span class='kw'>extra_css</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  176. <span class='kw'>extra_fonts</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  177. <span class='kw'>outfile</span> <span class='kw'>=</span> <span class='st'>"xaringan-themer.css"</span>
  178. )</pre>
  179. <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
  180. <table class="ref-arguments">
  181. <colgroup><col class="name" /><col class="desc" /></colgroup>
  182. <tr>
  183. <th>font_arg</th>
  184. <td><p>A font argument from the <span class="pkg">xaringanthemer</span> <code>style_</code>
  185. function family.</p></td>
  186. </tr>
  187. <tr>
  188. <th>text_color</th>
  189. <td><p>Text Color. Defaults to #000. Modifies the <code>body</code> element.
  190. The value of this variable is also stored as a CSS variable that can be
  191. referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--text_color)</a></code> in any argument of a style function or
  192. in custom CSS.</p></td>
  193. </tr>
  194. <tr>
  195. <th>header_color</th>
  196. <td><p>Header Color. Defaults to #000. Modifies the
  197. <code>h1, h2, h3</code> elements. The value of this variable is also stored as a CSS
  198. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--header-color)</a></code> in any argument
  199. of a style function or in custom CSS.</p></td>
  200. </tr>
  201. <tr>
  202. <th>background_color</th>
  203. <td><p>Slide Background Color. Defaults to #FFF. Modifies
  204. the <code>.remark-slide-content</code> class. The value of this variable is also
  205. stored as a CSS variable that can be referenced with
  206. <code><a href='https://rdrr.io/r/stats/cor.html'>var(--background-color)</a></code> in any argument of a style function or in custom
  207. CSS.</p></td>
  208. </tr>
  209. <tr>
  210. <th>link_color</th>
  211. <td><p>Link Color. Defaults to rgb(249, 38, 114). Modifies the
  212. <code>a, a &gt; code</code> elements. The value of this variable is also stored as a CSS
  213. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--link-color)</a></code> in any argument
  214. of a style function or in custom CSS.</p></td>
  215. </tr>
  216. <tr>
  217. <th>text_bold_color</th>
  218. <td><p>Bold Text Color. Defaults to <code>NULL</code>. Modifies the
  219. <code>strong</code> element. The value of this variable is also stored as a CSS
  220. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--text-bold-color)</a></code> in any
  221. argument of a style function or in custom CSS.</p></td>
  222. </tr>
  223. <tr>
  224. <th>text_slide_number_color</th>
  225. <td><p>Slide Number Color. Defaults to
  226. <code>inverse_background_color</code>. Modifies the <code>.remark-slide-number</code> class.</p></td>
  227. </tr>
  228. <tr>
  229. <th>padding</th>
  230. <td><p>Slide Padding in <code>top right [bottom left]</code> format. Defaults
  231. to 16px 64px 16px 64px. Modifies the <code>.remark-slide-content</code> class.
  232. Accepts CSS
  233. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/padding'>padding</a>
  234. property values.</p></td>
  235. </tr>
  236. <tr>
  237. <th>background_image</th>
  238. <td><p>Background image applied to each <em>and every</em> slide.
  239. Set <code>title_slide_background_image = "none"</code> to remove the background image
  240. from the title slide. Defaults to <code>NULL</code>. Modifies the
  241. <code>.remark-slide-content</code> class.</p></td>
  242. </tr>
  243. <tr>
  244. <th>background_size</th>
  245. <td><p>Background image size, requires <code>background_image</code> to
  246. be set. If <code>background_image</code> is set, <code>background_size</code> will default to
  247. <code>cover</code> so the backround fills the screen. If both <code>background_image</code> and
  248. <code>background_position</code> are set, will default to 100 percent. Defaults to
  249. <code>NULL</code>. Modifies the <code>.remark-slide-content</code> class. Accepts CSS
  250. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/background-size'>background-size</a>
  251. property values.</p></td>
  252. </tr>
  253. <tr>
  254. <th>background_position</th>
  255. <td><p>Background image position, requires
  256. <code>background_image</code> to be set, and it is recommended to adjust
  257. <code>background_size</code>. Defaults to <code>NULL</code>. Modifies the
  258. <code>.remark-slide-content</code> class. Accepts CSS
  259. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/background-position'>background-position</a>
  260. property values.</p></td>
  261. </tr>
  262. <tr>
  263. <th>code_highlight_color</th>
  264. <td><p>Code Line Highlight. Defaults to
  265. rgba(255,255,0,0.5). Modifies the <code>.remark-code-line-highlighted</code> class.
  266. The value of this variable is also stored as a CSS variable that can be
  267. referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--code-highlight-color)</a></code> in any argument of a style
  268. function or in custom CSS.</p></td>
  269. </tr>
  270. <tr>
  271. <th>code_inline_color</th>
  272. <td><p>Inline Code Color. Defaults to #000. Modifies the
  273. <code>.remark-inline-code</code> class.</p></td>
  274. </tr>
  275. <tr>
  276. <th>code_inline_background_color</th>
  277. <td><p>Inline Code Background Color. Defaults
  278. to <code>NULL</code>. Modifies the <code>.remark-inline-code</code> class.</p></td>
  279. </tr>
  280. <tr>
  281. <th>code_inline_font_size</th>
  282. <td><p>Inline Code Text Font Size. Defaults to 1em.
  283. Modifies the <code>.remark-inline-code</code> class. Accepts CSS
  284. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-size'>font-size</a>
  285. property values. The value of this variable is also stored as a CSS
  286. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--code-inline-font-size)</a></code> in any
  287. argument of a style function or in custom CSS.</p></td>
  288. </tr>
  289. <tr>
  290. <th>inverse_background_color</th>
  291. <td><p>Inverse Background Color. Defaults to
  292. #272822. Modifies the <code>.inverse</code> class. The value of this variable is also
  293. stored as a CSS variable that can be referenced with
  294. <code><a href='https://rdrr.io/r/stats/cor.html'>var(--inverse-background-color)</a></code> in any argument of a style function or
  295. in custom CSS.</p></td>
  296. </tr>
  297. <tr>
  298. <th>inverse_text_color</th>
  299. <td><p>Inverse Text Color. Defaults to #d6d6d6. Modifies
  300. the <code>.inverse</code> class. The value of this variable is also stored as a CSS
  301. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--inverse-text-color)</a></code> in any
  302. argument of a style function or in custom CSS.</p></td>
  303. </tr>
  304. <tr>
  305. <th>inverse_text_shadow</th>
  306. <td><p>Enables Shadow on text of inverse slides.
  307. Defaults to <code>FALSE</code>. Modifies the <code>.inverse</code> class.</p></td>
  308. </tr>
  309. <tr>
  310. <th>inverse_header_color</th>
  311. <td><p>Inverse Header Color. Defaults to #f3f3f3.
  312. Modifies the <code>.inverse h1, .inverse h2, .inverse h3</code> classes. The value of
  313. this variable is also stored as a CSS variable that can be referenced with
  314. <code><a href='https://rdrr.io/r/stats/cor.html'>var(--inverse-header-color)</a></code> in any argument of a style function or in
  315. custom CSS.</p></td>
  316. </tr>
  317. <tr>
  318. <th>title_slide_text_color</th>
  319. <td><p>Title Slide Text Color. Defaults to
  320. <code>inverse_text_color</code>. Modifies the <code>.title-slide</code> class. The value of this
  321. variable is also stored as a CSS variable that can be referenced with
  322. <code><a href='https://rdrr.io/r/stats/cor.html'>var(--title-slide-text-color)</a></code> in any argument of a style function or in
  323. custom CSS.</p></td>
  324. </tr>
  325. <tr>
  326. <th>title_slide_background_color</th>
  327. <td><p>Title Slide Background Color. Defaults
  328. to <code>inverse_background_color</code>. Modifies the <code>.title-slide</code> class. The
  329. value of this variable is also stored as a CSS variable that can be
  330. referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--title-slide-background-color)</a></code> in any argument of a
  331. style function or in custom CSS.</p></td>
  332. </tr>
  333. <tr>
  334. <th>title_slide_background_image</th>
  335. <td><p>Title Slide Background Image URL.
  336. Defaults to <code>NULL</code>. Modifies the <code>.title-slide</code> class.</p></td>
  337. </tr>
  338. <tr>
  339. <th>title_slide_background_size</th>
  340. <td><p>Title Slide Background Image Size,
  341. defaults to "cover" if background image is set. Defaults to <code>NULL</code>.
  342. Modifies the <code>.title-slide</code> class. Accepts CSS
  343. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/background-size'>background-size</a>
  344. property values.</p></td>
  345. </tr>
  346. <tr>
  347. <th>title_slide_background_position</th>
  348. <td><p>Title Slide Background Image
  349. Position. Defaults to <code>NULL</code>. Modifies the <code>.title-slide</code> class. Accepts
  350. CSS
  351. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/background-position'>background-position</a>
  352. property values.</p></td>
  353. </tr>
  354. <tr>
  355. <th>footnote_color</th>
  356. <td><p>Footnote text color (if <code>NA</code>, then it will be the same
  357. color as <code>text_color</code>). Defaults to <code>NULL</code>. Modifies the <code>.footnote</code>
  358. class.</p></td>
  359. </tr>
  360. <tr>
  361. <th>footnote_font_size</th>
  362. <td><p>Footnote font size. Defaults to 0.9em. Modifies
  363. the <code>.footnote</code> class. Accepts CSS
  364. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-size'>font-size</a>
  365. property values.</p></td>
  366. </tr>
  367. <tr>
  368. <th>footnote_position_bottom</th>
  369. <td><p>Footnote location from bottom of screen.
  370. Defaults to 60px. Modifies the <code>.footnote</code> class. Accepts CSS
  371. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/position_value'>position</a>
  372. property values.</p></td>
  373. </tr>
  374. <tr>
  375. <th>left_column_subtle_color</th>
  376. <td><p>Left Column Text (not last). Defaults to
  377. #777. Modifies the <code>.left-column h2, .left-column h3</code> classes.</p></td>
  378. </tr>
  379. <tr>
  380. <th>left_column_selected_color</th>
  381. <td><p>Left Column Current Selection. Defaults to
  382. #000. Modifies the
  383. <code>.left-column h2:last-of-type, .left-column h3:last-child</code> classes.</p></td>
  384. </tr>
  385. <tr>
  386. <th>blockquote_left_border_color</th>
  387. <td><p>Blockquote Left Border Color. Defaults
  388. to lightgray. Modifies the <code>blockquote</code> element.</p></td>
  389. </tr>
  390. <tr>
  391. <th>table_border_color</th>
  392. <td><p>Table top/bottom border. Defaults to #666.
  393. Modifies the <code>table: border-top, border-bottom</code> elements.</p></td>
  394. </tr>
  395. <tr>
  396. <th>table_row_border_color</th>
  397. <td><p>Table row inner bottom border. Defaults to
  398. #ddd. Modifies the <code>table thead th: border-bottom</code> elements.</p></td>
  399. </tr>
  400. <tr>
  401. <th>table_row_even_background_color</th>
  402. <td><p>Table Even Row Background Color.
  403. Defaults to #eee. Modifies the <code>thead, tfoot, tr:nth-child(even)</code>
  404. elements.</p></td>
  405. </tr>
  406. <tr>
  407. <th>base_font_size</th>
  408. <td><p>Base Font Size for All Slide Elements (must be <code>px</code>).
  409. Defaults to 20px. Modifies the <code>html</code> element. The value of this variable
  410. is also stored as a CSS variable that can be referenced with
  411. <code><a href='https://rdrr.io/r/stats/cor.html'>var(--base-font-size)</a></code> in any argument of a style function or in custom
  412. CSS.</p></td>
  413. </tr>
  414. <tr>
  415. <th>text_font_size</th>
  416. <td><p>Slide Body Text Font Size. Defaults to 1rem. Modifies
  417. the <code>.remark-slide-content</code> class. Accepts CSS
  418. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-size'>font-size</a>
  419. property values. The value of this variable is also stored as a CSS
  420. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--text-font-size)</a></code> in any
  421. argument of a style function or in custom CSS.</p></td>
  422. </tr>
  423. <tr>
  424. <th>header_h1_font_size</th>
  425. <td><p>h1 Header Text Font Size. Defaults to 2.75rem.
  426. Modifies the <code>.remark-slide-content h1</code> class. Accepts CSS
  427. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-size'>font-size</a>
  428. property values. The value of this variable is also stored as a CSS
  429. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--header-h1-font-size)</a></code> in any
  430. argument of a style function or in custom CSS.</p></td>
  431. </tr>
  432. <tr>
  433. <th>header_h2_font_size</th>
  434. <td><p>h2 Header Text Font Size. Defaults to 2.25rem.
  435. Modifies the <code>.remark-slide-content h2</code> class. Accepts CSS
  436. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-size'>font-size</a>
  437. property values. The value of this variable is also stored as a CSS
  438. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--header-h2-font-size)</a></code> in any
  439. argument of a style function or in custom CSS.</p></td>
  440. </tr>
  441. <tr>
  442. <th>header_h3_font_size</th>
  443. <td><p>h3 Header Text Font Size. Defaults to 1.75rem.
  444. Modifies the <code>.remark-slide-content h3</code> class. Accepts CSS
  445. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-size'>font-size</a>
  446. property values. The value of this variable is also stored as a CSS
  447. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--header-h3-font-size)</a></code> in any
  448. argument of a style function or in custom CSS.</p></td>
  449. </tr>
  450. <tr>
  451. <th>header_background_auto</th>
  452. <td><p>Add background under slide title automatically
  453. for h1 header elements. If not enabled, use <code>class: header_background</code> to
  454. enable. Defaults to <code>FALSE</code>.</p></td>
  455. </tr>
  456. <tr>
  457. <th>header_background_color</th>
  458. <td><p>Background Color for h1 Header with
  459. Background. Defaults to <code>header_color</code>. Modifies the
  460. <code>.remark-slide-content h1</code> class. The value of this variable is also
  461. stored as a CSS variable that can be referenced with
  462. <code><a href='https://rdrr.io/r/stats/cor.html'>var(--header-background-color)</a></code> in any argument of a style function or in
  463. custom CSS.</p></td>
  464. </tr>
  465. <tr>
  466. <th>header_background_text_color</th>
  467. <td><p>Text Color for h1 Header with
  468. Background. Defaults to <code>background_color</code>. Modifies the
  469. <code>.remark-slide-content h1</code> class. The value of this variable is also
  470. stored as a CSS variable that can be referenced with
  471. <code><a href='https://rdrr.io/r/stats/cor.html'>var(--header-background-text-color)</a></code> in any argument of a style function
  472. or in custom CSS.</p></td>
  473. </tr>
  474. <tr>
  475. <th>header_background_padding</th>
  476. <td><p>Padding for h1 Header with Background.
  477. Defaults to <code>NULL</code>. Modifies the <code>.remark-slide-content h1</code> class. Accepts
  478. CSS <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/padding'>padding</a>
  479. property values.</p></td>
  480. </tr>
  481. <tr>
  482. <th>header_background_content_padding_top</th>
  483. <td><p>Top Padding for Content in
  484. Slide with Header with Background. Defaults to 7rem. Modifies the
  485. <code>.remark-slide-content</code> class.</p></td>
  486. </tr>
  487. <tr>
  488. <th>header_background_ignore_classes</th>
  489. <td><p>Slide Classes Where Header with
  490. Background will not be Applied. Defaults to
  491. <code><a href='https://rdrr.io/r/base/c.html'>c('normal', 'inverse', 'title', 'middle', 'bottom')</a></code>. Modifies the
  492. <code>.remark-slide-content</code> class.</p></td>
  493. </tr>
  494. <tr>
  495. <th>text_slide_number_font_size</th>
  496. <td><p>Slide Number Text Font Size. Defaults to
  497. 0.9em. Modifies the <code>.remark-slide-number</code> class. Accepts CSS
  498. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-size'>font-size</a>
  499. property values.</p></td>
  500. </tr>
  501. <tr>
  502. <th>text_font_google</th>
  503. <td><p>Use <code><a href='google_font.html'>google_font()</a></code> to specify body font. Defaults
  504. to <code>NULL</code>. Modifies the <code>body</code> element.</p></td>
  505. </tr>
  506. <tr>
  507. <th>text_font_family</th>
  508. <td><p>Body Text Font Family (xaringan default is
  509. <code>'Droid Serif'</code>). Defaults to
  510. <code>xaringanthemer_font_default("text_font_family")</code>. Modifies the <code>body</code>
  511. element. The value of this variable is also stored as a CSS variable that
  512. can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--text-font-family)</a></code> in any argument of a
  513. style function or in custom CSS.</p></td>
  514. </tr>
  515. <tr>
  516. <th>text_font_weight</th>
  517. <td><p>Body Text Font Weight. Defaults to
  518. <code>xaringanthemer_font_default("text_font_weight")</code>. Modifies the <code>body</code>
  519. element. Accepts CSS
  520. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight'>font-weight</a>
  521. property values.</p></td>
  522. </tr>
  523. <tr>
  524. <th>text_font_url</th>
  525. <td><p>Body Text Font URL(s). Defaults to
  526. <code>xaringanthemer_font_default("text_font_url")</code>. Modifies the
  527. <code>@import url()</code> elements.</p></td>
  528. </tr>
  529. <tr>
  530. <th>text_font_family_fallback</th>
  531. <td><p>Body Text Font Fallbacks. Defaults to
  532. <code>xaringanthemer_font_default("text_font_family_fallback")</code>. Modifies the
  533. <code>body</code> element. The value of this variable is also stored as a CSS
  534. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--text-font-family-fallback)</a></code> in
  535. any argument of a style function or in custom CSS.</p></td>
  536. </tr>
  537. <tr>
  538. <th>text_font_base</th>
  539. <td><p>Body Text Base Font (Total Failure Fallback). Defaults
  540. to sans-serif. Modifies the <code>body</code> element. The value of this variable is
  541. also stored as a CSS variable that can be referenced with
  542. <code><a href='https://rdrr.io/r/stats/cor.html'>var(--text-font-base)</a></code> in any argument of a style function or in custom
  543. CSS.</p></td>
  544. </tr>
  545. <tr>
  546. <th>header_font_google</th>
  547. <td><p>Use <code><a href='google_font.html'>google_font()</a></code> to specify header font.
  548. Defaults to <code>NULL</code>. Modifies the <code>body</code> element.</p></td>
  549. </tr>
  550. <tr>
  551. <th>header_font_family</th>
  552. <td><p>Header Font Family (xaringan default is
  553. <code>'Yanone Kaffeesatz'</code>). Defaults to
  554. <code>xaringanthemer_font_default("header_font_family")</code>. Modifies the
  555. <code>h1, h2, h3</code> elements. The value of this variable is also stored as a CSS
  556. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--header-font-family)</a></code> in any
  557. argument of a style function or in custom CSS.</p></td>
  558. </tr>
  559. <tr>
  560. <th>header_font_weight</th>
  561. <td><p>Header Font Weight. Defaults to
  562. <code>xaringanthemer_font_default("header_font_weight")</code>. Modifies the
  563. <code>h1, h2, h3</code> elements. Accepts CSS
  564. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight'>font-weight</a>
  565. property values.</p></td>
  566. </tr>
  567. <tr>
  568. <th>header_font_url</th>
  569. <td><p>Header Font URL. Defaults to
  570. <code>xaringanthemer_font_default("header_font_url")</code>. Modifies the
  571. <code>@import url</code> elements.</p></td>
  572. </tr>
  573. <tr>
  574. <th>code_font_google</th>
  575. <td><p>Use <code><a href='google_font.html'>google_font()</a></code> to specify code font. Defaults
  576. to <code>NULL</code>. Modifies the <code>body</code> element.</p></td>
  577. </tr>
  578. <tr>
  579. <th>code_font_family</th>
  580. <td><p>Code Font Family. Defaults to
  581. <code>xaringanthemer_font_default("code_font_family")</code>. Modifies the
  582. <code>.remark-code, .remark-inline-code</code> classes. The value of this variable is
  583. also stored as a CSS variable that can be referenced with
  584. <code><a href='https://rdrr.io/r/stats/cor.html'>var(--code-font-family)</a></code> in any argument of a style function or in custom
  585. CSS.</p></td>
  586. </tr>
  587. <tr>
  588. <th>code_font_size</th>
  589. <td><p>Code Text Font Size. Defaults to 0.9rem. Modifies the
  590. <code>.remark-inline</code> class. Accepts CSS
  591. <a href='https://developer.mozilla.org/en-US/docs/Web/CSS/font-size'>font-size</a>
  592. property values. The value of this variable is also stored as a CSS
  593. variable that can be referenced with <code><a href='https://rdrr.io/r/stats/cor.html'>var(--code-font-size)</a></code> in any
  594. argument of a style function or in custom CSS.</p></td>
  595. </tr>
  596. <tr>
  597. <th>code_font_url</th>
  598. <td><p>Code Font URL. Defaults to
  599. <code>xaringanthemer_font_default("code_font_url")</code>. Modifies the <code>@import url</code>
  600. elements.</p></td>
  601. </tr>
  602. <tr>
  603. <th>code_font_family_fallback</th>
  604. <td><p>Code Font Fallback. Defaults to
  605. <code>xaringanthemer_font_default("code_font_family_fallback")</code>. Modifies the
  606. <code>.remark-code, .remark-inline-code</code> classes.</p></td>
  607. </tr>
  608. <tr>
  609. <th>colors</th>
  610. <td><p>A named vector of custom colors. The names of the colors
  611. become CSS variables and classes that can be used within your slides.
  612. For example, <code>colors = c(blue = "#bad4ed")</code> adds a CSS variable
  613. <code>--blue</code>, a <code>.blue</code> CSS class that applies the color to the text or
  614. foreground color, and a <code>.bg-blue</code> CSS class that applies the color
  615. to the background.</p></td>
  616. </tr>
  617. <tr>
  618. <th>extra_css</th>
  619. <td><p>A named list of CSS definitions each containing a named list
  620. of CSS property-value pairs, i.e.
  621. <code><a href='https://rdrr.io/r/base/list.html'>list(".class-id" = list("css-property" = "value"))</a></code>.</p></td>
  622. </tr>
  623. <tr>
  624. <th>extra_fonts</th>
  625. <td><p>A list of additional fonts to import, each list element
  626. can be either a URL as a character string or a call to
  627. <code><a href='google_font.html'>google_font</a>()</code>. To use a font imported in <code>extra_fonts</code>, you
  628. will need to write custom CSS rules that apply the font to an element or
  629. class with the <code>font-family</code> property. See the <strong>Fonts</strong> section of
  630. <code><a href='../articles/xaringanthemer.html'>vignette("xaringanthemer")</a></code> for an example.</p></td>
  631. </tr>
  632. <tr>
  633. <th>outfile</th>
  634. <td><p>Customized xaringan CSS output file name, default is "xaringan-themer.css"</p></td>
  635. </tr>
  636. </table>
  637. <h2 class="hasAnchor" id="functions"><a class="anchor" href="#functions"></a>Functions</h2>
  638. <ul>
  639. <li><p><code>xaringanthemer_font_default</code>: Default values for font family, wieght, URLs and
  640. font fallbacks.</p></li>
  641. </ul>
  642. <h2 class="hasAnchor" id="usage"><a class="anchor" href="#usage"></a>Usage</h2>
  643. <p>To use the styles created by this theme function, make sure
  644. that you use <code>xaringan-themer.css</code> as your CSS file in your slides' YAML
  645. header. If you change the name of the output file using the <code>outfile</code>
  646. argument, use that name instead of the default file name.<div class="yaml"></p><pre><span class='no'>output</span>:
  647. <span class='kw pkg'>xaringan</span><span class='kw ns'>::</span><span class='no'><a href='https://rdrr.io/pkg/xaringan/man/moon_reader.html'>moon_reader</a></span>:
  648. <span class='no'>css</span>: <span class='no'>xaringan</span>-<span class='no'>themer.css</span></pre><p></div></p>
  649. <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
  650. <div class='dont-index'><p>Other themes:
  651. <code><a href='style_duo_accent_inverse.html'>style_duo_accent_inverse</a>()</code>,
  652. <code><a href='style_duo_accent.html'>style_duo_accent</a>()</code>,
  653. <code><a href='style_duo.html'>style_duo</a>()</code>,
  654. <code><a href='style_mono_accent_inverse.html'>style_mono_accent_inverse</a>()</code>,
  655. <code><a href='style_mono_accent.html'>style_mono_accent</a>()</code>,
  656. <code><a href='style_mono_dark.html'>style_mono_dark</a>()</code>,
  657. <code><a href='style_mono_light.html'>style_mono_light</a>()</code>,
  658. <code><a href='style_solarized_dark.html'>style_solarized_dark</a>()</code>,
  659. <code><a href='style_solarized_light.html'>style_solarized_light</a>()</code></p></div>
  660. <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
  661. <pre class="examples"><div class='input'><span class='co'># Create a xaringan style in a temporary file</span>
  662. <span class='no'>xaringan_themer_css</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/tempfile.html'>tempfile</a></span>(<span class='st'>"xaringan-themer-"</span>, <span class='kw'>fileext</span> <span class='kw'>=</span> <span class='st'>".css"</span>)
  663. <span class='fu'>style_xaringan</span>(
  664. <span class='kw'>text_color</span> <span class='kw'>=</span> <span class='st'>"#002b3"</span>,
  665. <span class='kw'>inverse_background_color</span> <span class='kw'>=</span> <span class='st'>"#31b09e"</span>,
  666. <span class='kw'>inverse_text_color</span> <span class='kw'>=</span> <span class='st'>"#002b3"</span>,
  667. <span class='kw'>outfile</span> <span class='kw'>=</span> <span class='no'>xaringan_themer_css</span> <span class='co'># omit in your slides to write the</span>
  668. <span class='co'># styles to xaringan-themer.css</span>
  669. )
  670. <span class='co'># View the CSS:</span>
  671. <span class='co'># file.edit(xaringan_themer_css)</span></div></pre>
  672. </div>
  673. <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
  674. <nav id="toc" data-toggle="toc" class="sticky-top">
  675. <h2 data-toc-skip>Contents</h2>
  676. </nav>
  677. </div>
  678. </div>
  679. <footer>
  680. <div class="copyright">
  681. <p>Developed by <a href='https://www.garrickadenbuie.com'>Garrick Aden-Buie</a>.</p>
  682. </div>
  683. <div class="pkgdown">
  684. <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.</p>
  685. </div>
  686. </footer>
  687. </div>
  688. </body>
  689. </html>