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

263 lines
18KB

  1. <!DOCTYPE html>
  2. <!-- Generated by pkgdown: do not edit by hand --><html lang="en">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  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, shrink-to-fit=no">
  8. <meta name="description" content="Give your xaringan slides some style with xaringanthemer.
  9. Easy slide and plot themes for xaringan slides.
  10. ">
  11. <title>Custom xaringan CSS Themes • xaringanthemer</title>
  12. <!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
  13. <link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
  14. <link rel="apple-touch-icon" type="image/png" sizes="180x180" href="apple-touch-icon.png">
  15. <link rel="apple-touch-icon" type="image/png" sizes="120x120" href="apple-touch-icon-120x120.png">
  16. <link rel="apple-touch-icon" type="image/png" sizes="76x76" href="apple-touch-icon-76x76.png">
  17. <link rel="apple-touch-icon" type="image/png" sizes="60x60" href="apple-touch-icon-60x60.png">
  18. <script src="deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  19. <link href="deps/bootstrap-5.1.0/bootstrap.min.css" rel="stylesheet">
  20. <script src="deps/bootstrap-5.1.0/bootstrap.bundle.min.js"></script><link href="deps/_IBM%20Plex%20Mono-0.4.0/font.css" rel="stylesheet">
  21. <link href="deps/_Poppins-0.4.0/font.css" rel="stylesheet">
  22. <!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous">
  23. <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">
  24. <!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><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><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="pkgdown.js"></script><link href="extra.css" rel="stylesheet">
  25. <meta property="og:title" content="Custom xaringan CSS Themes">
  26. <meta property="og:description" content="Give your xaringan slides some style with xaringanthemer.
  27. Easy slide and plot themes for xaringan slides.
  28. ">
  29. <meta property="og:image" content="https://pkg.garrickadenbuie.com/xaringanthemer/logo.png">
  30. <meta name="twitter:card" content="summary">
  31. <meta name="twitter:creator" content="@grrrck">
  32. <meta name="twitter:site" content="@grrrck">
  33. <!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><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><!--[if lt IE 9]>
  34. <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
  35. <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  36. <![endif]-->
  37. </head>
  38. <body>
  39. <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
  40. <nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
  41. <a class="navbar-brand me-2" href="index.html">xaringanthemer</a>
  42. <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">0.4.1</small>
  43. <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
  44. <span class="navbar-toggler-icon"></span>
  45. </button>
  46. <div id="navbar" class="collapse navbar-collapse ms-2">
  47. <ul class="navbar-nav me-auto">
  48. <li class="nav-item">
  49. <a class="nav-link" href="articles/xaringanthemer.html">Features</a>
  50. </li>
  51. <li class="nav-item">
  52. <a class="nav-link" href="reference/index.html">Reference</a>
  53. </li>
  54. <li class="nav-item dropdown">
  55. <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-themes">Themes</a>
  56. <div class="dropdown-menu" aria-labelledby="dropdown-themes">
  57. <h6 class="dropdown-header" data-toc-skip>Themes</h6>
  58. <a class="dropdown-item" href="articles/themes.html">Slide Themes</a>
  59. <a class="dropdown-item" href="articles/ggplot2-themes.html">ggplot2 Themes</a>
  60. <div class="dropdown-divider"></div>
  61. <h6 class="dropdown-header" data-toc-skip>More Customization</h6>
  62. <a class="dropdown-item" href="articles/fonts.html">Fonts</a>
  63. <a class="dropdown-item" href="articles/template-variables.html">Template Variables</a>
  64. </div>
  65. </li>
  66. </ul>
  67. <form class="form-inline my-2 my-lg-0" role="search">
  68. <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="search.json" id="search-input" placeholder="Search for" autocomplete="off">
  69. </form>
  70. <ul class="navbar-nav">
  71. <li class="nav-item dropdown">
  72. <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown--">
  73. <span class="far fa far fa-newspaper fa-lg"></span>
  74. </a>
  75. <div class="dropdown-menu" aria-labelledby="dropdown--">
  76. <a class="external-link dropdown-item" href="https://garrickadenbuie.com/blog/xaringanthemer-v0-3-0/">xaringanthemer 0.3.0</a>
  77. <div class="dropdown-divider"></div>
  78. <a class="dropdown-item" href="news/index.html">Changelog</a>
  79. </div>
  80. </li>
  81. <li class="nav-item">
  82. <a class="external-link nav-link" href="https://github.com/gadenbuie/xaringanthemer">
  83. <span class="fab fa fab fa-github fa-lg"></span>
  84. </a>
  85. </li>
  86. <li class="nav-item">
  87. <a class="external-link nav-link" href="https://twitter.com/grrrck">
  88. <span class="fab fa fab fa-twitter fa-lg"></span>
  89. </a>
  90. </li>
  91. <li class="nav-item">
  92. <a class="external-link nav-link" href="https://www.garrickadenbuie.com">
  93. <span class="fas fa fas fa-home fa-lg"></span>
  94. </a>
  95. </li>
  96. </ul>
  97. </div>
  98. </div>
  99. </nav><div class="container template-home">
  100. <div class="row">
  101. <main id="main" class="col-md-9"><div class="section level1">
  102. <div class="page-header">
  103. <img src="logo.png" class="logo" alt=""><h1 id="xaringanthemer-">xaringanthemer <a class="anchor" aria-label="anchor" href="#xaringanthemer-"></a>
  104. </h1>
  105. </div>
  106. <!-- badges: start -->
  107. <p>Give your <a href="https://github.com/yihui/xaringan" class="external-link">xaringan</a> slides some style with <strong>xaringanthemer</strong> within your <code>slides.Rmd</code> file without (much) CSS.</p>
  108. <p><img src="https://raw.githubusercontent.com/gadenbuie/xaringanthemer/assets/examples.gif" alt="Animation previewing many xaringanthemer themes"></p>
  109. <div class="section level2">
  110. <h2 id="installation">Installation<a class="anchor" aria-label="anchor" href="#installation"></a>
  111. </h2>
  112. <p>You can install <strong>xaringanthemer</strong> from CRAN</p>
  113. <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
  114. <code class="sourceCode R"><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html" class="external-link">install.packages</a></span><span class="op">(</span><span class="st">"xaringanthemer"</span><span class="op">)</span></code></pre></div>
  115. <p>or you can install the development version of xaringanthemer from <a href="https://github.com/gadenbuie/xaringanthemer" class="external-link">GitHub</a>.</p>
  116. <div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
  117. <code class="sourceCode R"><span class="co"># install.packages("remotes")</span>
  118. <span class="fu">remotes</span><span class="fu">::</span><span class="fu">install_github</span><span class="op">(</span><span class="st">"gadenbuie/xaringanthemer"</span><span class="op">)</span></code></pre></div>
  119. </div>
  120. <div class="section level2">
  121. <h2 id="quick-intro">Quick Intro<a class="anchor" aria-label="anchor" href="#quick-intro"></a>
  122. </h2>
  123. <!-- Set link to theme-settings, template-variables, theme functions -->
  124. <p>First, add the <code>xaringan-themer.css</code> file to the YAML header of your xaringan slides.</p>
  125. <div class="sourceCode" id="cb3"><pre class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb3-1"><a href="#cb3-1"></a><span class="fu">output</span><span class="kw">:</span></span>
  126. <span id="cb3-2"><a href="#cb3-2"></a><span class="at"> xaringan:</span><span class="fu">:moon_reader</span><span class="kw">:</span></span>
  127. <span id="cb3-3"><a href="#cb3-3"></a><span class="at"> </span><span class="fu">css</span><span class="kw">:</span><span class="at"> xaringan-themer.css</span></span></code></pre></div>
  128. <p>Then, in a hidden chunk just after the knitr setup chunk, load <strong>xaringanthemer</strong> and try one of the <a href="#themes">theme functions</a>.</p>
  129. <div class="sourceCode" id="cb4"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb4-1"><a href="#cb4-1"></a><span class="bn">```{r xaringan-themer, include=FALSE, warning=FALSE}</span></span>
  130. <span id="cb4-2"><a href="#cb4-2"></a><span class="bn">library(xaringanthemer)</span></span>
  131. <span id="cb4-3"><a href="#cb4-3"></a><span class="bn">style_mono_accent(</span></span>
  132. <span id="cb4-4"><a href="#cb4-4"></a><span class="bn"> base_color = "#1c5253",</span></span>
  133. <span id="cb4-5"><a href="#cb4-5"></a><span class="bn"> header_font_google = google_font("Josefin Sans"),</span></span>
  134. <span id="cb4-6"><a href="#cb4-6"></a><span class="bn"> text_font_google = google_font("Montserrat", "300", "300i"),</span></span>
  135. <span id="cb4-7"><a href="#cb4-7"></a><span class="bn"> code_font_google = google_font("Fira Mono")</span></span>
  136. <span id="cb4-8"><a href="#cb4-8"></a><span class="bn">)</span></span>
  137. <span id="cb4-9"><a href="#cb4-9"></a><span class="bn">```</span></span></code></pre></div>
  138. <p><img src="https://raw.githubusercontent.com/gadenbuie/xaringanthemer/assets/example_mono_accent_1c5253.png" alt="Example title and normal slides using a green xaringanthemer theme" data-external="1"></p>
  139. <div class="section level3">
  140. <h3 id="matching-ggplot-themes">Matching ggplot Themes<a class="anchor" aria-label="anchor" href="#matching-ggplot-themes"></a>
  141. </h3>
  142. <p><strong>xaringanthemer</strong> even provides a <a href="https://ggplot2.tidyverse.org" class="external-link">ggplot2</a> theme with <code><a href="reference/theme_xaringan.html">theme_xaringan()</a></code> that uses the colors and fonts from your slide theme. Built on the <a href="https://github.com/yixuan/showtext" class="external-link">showtext</a> package, and designed to work seamlessly with <a href="https://fonts.google.com" class="external-link">Google Fonts</a>.</p>
  143. <p>Color and fill scales are also provided for matching sequential color scales based on the primary color used in your slides. See <code><a href="reference/scale_xaringan.html">?scale_xaringan</a></code> for more details.</p>
  144. <p>More details and examples can be found in <code><a href="articles/ggplot2-themes.html">vignette("ggplot2-themes")</a></code>.</p>
  145. <div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
  146. <code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://ggplot2.tidyverse.org" class="external-link">ggplot2</a></span><span class="op">)</span>
  147. <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/ggplot.html" class="external-link">ggplot</a></span><span class="op">(</span><span class="va">diamonds</span><span class="op">)</span> <span class="op">+</span>
  148. <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/aes.html" class="external-link">aes</a></span><span class="op">(</span><span class="va">cut</span>, fill <span class="op">=</span> <span class="va">cut</span><span class="op">)</span> <span class="op">+</span>
  149. <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/geom_bar.html" class="external-link">geom_bar</a></span><span class="op">(</span>show.legend <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span> <span class="op">+</span>
  150. <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/labs.html" class="external-link">labs</a></span><span class="op">(</span>
  151. x <span class="op">=</span> <span class="st">"Cut"</span>,
  152. y <span class="op">=</span> <span class="st">"Count"</span>,
  153. title <span class="op">=</span> <span class="st">"A Fancy diamonds Plot"</span>
  154. <span class="op">)</span> <span class="op">+</span>
  155. <span class="fu"><a href="reference/theme_xaringan.html">theme_xaringan</a></span><span class="op">(</span>background_color <span class="op">=</span> <span class="st">"#FFFFFF"</span><span class="op">)</span> <span class="op">+</span>
  156. <span class="fu"><a href="reference/scale_xaringan.html">scale_xaringan_fill_discrete</a></span><span class="op">(</span><span class="op">)</span></code></pre></div>
  157. <p><img src="reference/figures/index-theme_xaringan_demo-1.png" width="100%"></p>
  158. </div>
  159. <div class="section level3">
  160. <h3 id="tab-completion">Tab Completion<a class="anchor" aria-label="anchor" href="#tab-completion"></a>
  161. </h3>
  162. <p><strong>xaringanthemer</strong> is <kbd>Tab</kbd> friendly – <a href="#theme-settings">use autocomplete to explore</a> the <a href="vignettes/template-variables.html">template variables</a> that you can adjust in each of the themes!</p>
  163. <p><img src="https://raw.githubusercontent.com/gadenbuie/xaringanthemer/assets/example-rstudio-completion.gif" alt="Demonstration of argument auto-completion with RStudio" data-external="1"></p>
  164. </div>
  165. <div class="section level3">
  166. <h3 id="r-markdown-template-in-rstudio">R Markdown Template in RStudio<a class="anchor" aria-label="anchor" href="#r-markdown-template-in-rstudio"></a>
  167. </h3>
  168. <p>You can also skip the above and just create a <em>Ninja Themed Presentation</em> from the New R Markdown Document menu in RStudio.</p>
  169. <center>
  170. <p><img src="https://raw.githubusercontent.com/gadenbuie/xaringanthemer/assets/rmarkdown-template-screenshot.png" alt="The 'New R Markdown Document' menu in RStudio" data-external="1"></p>
  171. </center>
  172. </div>
  173. </div>
  174. <div class="section level2">
  175. <h2 id="features">Features<a class="anchor" aria-label="anchor" href="#features"></a>
  176. </h2>
  177. <p>There’s a lot more that <strong>xaringanthemer</strong> can do! <a href="https://pkg.garrickadenbuie.com/xaringanthemer/articles/xaringanthemer.html">Discover xaringanthemer’s features.</a></p>
  178. </div>
  179. </div>
  180. </main><aside class="col-md-3"><div class="links">
  181. <h2 data-toc-skip>Links</h2>
  182. <ul class="list-unstyled">
  183. <li><a href="https://cloud.r-project.org/package=xaringanthemer" class="external-link">View on CRAN</a></li>
  184. <li><a href="https://github.com/gadenbuie/xaringanthemer/" class="external-link">Browse source code</a></li>
  185. <li><a href="https://github.com/gadenbuie/xaringanthemer/issues" class="external-link">Report a bug</a></li>
  186. </ul>
  187. </div>
  188. <div class="license">
  189. <h2 data-toc-skip>License</h2>
  190. <ul class="list-unstyled">
  191. <li><a href="LICENSE.html">Full license</a></li>
  192. <li><small><a href="https://opensource.org/licenses/mit-license.php" class="external-link">MIT</a> + file <a href="LICENSE-text.html">LICENSE</a></small></li>
  193. </ul>
  194. </div>
  195. <div class="citation">
  196. <h2 data-toc-skip>Citation</h2>
  197. <ul class="list-unstyled">
  198. <li><a href="authors.html#citation">Citing xaringanthemer</a></li>
  199. </ul>
  200. </div>
  201. <div class="developers">
  202. <h2 data-toc-skip>Developers</h2>
  203. <ul class="list-unstyled">
  204. <li>
  205. <a href="https://www.garrickadenbuie.com" class="external-link">Garrick Aden-Buie</a> <br><small class="roles"> Author, maintainer </small> <a href="https://orcid.org/0000-0002-7111-0077" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
  206. </ul>
  207. </div>
  208. <div class="dev-status">
  209. <h2 data-toc-skip>Dev status</h2>
  210. <ul class="list-unstyled">
  211. <li><a href="https://CRAN.R-project.org/package=xaringanthemer" class="external-link"><img src="https://www.r-pkg.org/badges/version/xaringanthemer" alt="CRAN status"></a></li>
  212. <li><a href="https://gadenbuie.r-universe.dev" class="external-link"><img src="https://gadenbuie.r-universe.dev/badges/xaringanthemer" alt="xaringanthemer status badge"></a></li>
  213. <li><a href="https://lifecycle.r-lib.org/articles/stages.html" class="external-link"><img src="https://img.shields.io/badge/lifecycle-stable-brightgreen.svg" alt="Lifecycle: stable"></a></li>
  214. <li><a href="https://github.com/gadenbuie/xaringanthemer/actions" class="external-link"><img src="https://github.com/gadenbuie/xaringanthemer/workflows/R-CMD-check/badge.svg?branch=main" alt="R-CMD-Check status badge"></a></li>
  215. <li><a href="https://codecov.io/github/gadenbuie/xaringanthemer" class="external-link"><img src="https://img.shields.io/codecov/c/github/gadenbuie/xaringanthemer" alt="Codecov"></a></li>
  216. </ul>
  217. </div>
  218. </aside>
  219. </div>
  220. <footer><div class="pkgdown-footer-left">
  221. <p></p>
  222. <p>Developed by <a href="https://www.garrickadenbuie.com" class="external-link">Garrick Aden-Buie</a>.</p>
  223. </div>
  224. <div class="pkgdown-footer-right">
  225. <p></p>
  226. <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.1.</p>
  227. </div>
  228. </footer>
  229. </div>
  230. </body>
  231. </html>