Skip to content

Commit 9959196

Browse files
committed
Add auto-completion gif and a few tweaks to docs
1 parent d52aabe commit 9959196

File tree

7 files changed

+52
-12
lines changed

7 files changed

+52
-12
lines changed

.Rbuildignore

+3
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@
55
^make\.R$
66
^vignettes/singles$
77
^tests_$
8+
^_.+$
9+
^docs$
10+
^index\.Rmd$

README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ devtools::install_github("gadenbuie/xaringanthemer")
3232

3333
<!-- Set link to theme-settings, template-variables, theme functions -->
3434

35-
First, add `css: xaringan-themer.css` to your xaringan slides YAML
36-
header under `xaringan::moonreader:`.
35+
First, add the `xaringan-themer.css` file to the YAML header of your
36+
xaringan slides.
3737

3838
``` yaml
3939
output:
@@ -59,21 +59,28 @@ mono_light(
5959
6060
<img src="vignettes/images/example_mono_light_1c5253.png" width="100%" />
6161
62+
### Tab Completion
63+
6264
**xaringanthemer** is <kbd>Tab</kbd> friendly – [use autocomplete to
6365
explore](#theme-settings) the [template
6466
variables](vignettes/template-variables.md) that you can adjust in each
6567
of the
6668
themes\!
6769
70+
<img src="vignettes/images/example-rstudio-completion.gif" width="100%" />
71+
72+
### R Markdown Template in RStudio
73+
74+
You can also skip the above and just create a *Ninja Themed
75+
Presentation* from the New R Markdown Document menu in
76+
RStudio.
77+
6878
<center>
6979
7080
<img src="vignettes/images/rmarkdown-template-screenshot.png" width="350px" />
7181
7282
</center>
7383
74-
You can also skip the above and just create a *Ninja Themed
75-
Presentation* from the New R Markdown Document menu in RStudio.
76-
7784
## Themes
7885
7986
### Monotone
Loading

docs/articles/xaringanthemer.html

+11-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/index.html

+11-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Loading

vignettes/rmdchunks/_quick-intro.Rmd

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Set link to theme-settings, template-variables, theme functions -->
22

3-
First, add `css: xaringan-themer.css` to your xaringan slides YAML header under `xaringan::moonreader:`.
3+
First, add the `xaringan-themer.css` file to the YAML header of your xaringan slides.
44

55
```yaml
66
output:
@@ -31,8 +31,22 @@ if (exists('IS_README') && IS_README) {
3131
}
3232
```
3333
34+
### Tab Completion
35+
3436
**xaringanthemer** is <kbd>Tab</kbd> friendly -- [use autocomplete to explore][theme-settings] the [template variables][template-variables] that you can adjust in each of the themes!
3537
38+
```{r}
39+
if (exists('IS_README') && IS_README) {
40+
knitr::include_graphics("vignettes/images/example-rstudio-completion.gif")
41+
} else {
42+
knitr::include_graphics(here::here("vignettes/images/example-rstudio-completion.gif"))
43+
}
44+
```
45+
46+
### R Markdown Template in RStudio
47+
48+
You can also skip the above and just create a *Ninja Themed Presentation* from the New R Markdown Document menu in RStudio.
49+
3650
<center>
3751
```{r out.width="350px"}
3852
if (exists('IS_README') && IS_README) {
@@ -42,5 +56,3 @@ if (exists('IS_README') && IS_README) {
4256
}
4357
```
4458
</center>
45-
46-
You can also skip the above and just create a *Ninja Themed Presentation* from the New R Markdown Document menu in RStudio.

0 commit comments

Comments
 (0)