Skip to content

Commit 05a1b32

Browse files
theme helpers: provide links to examples (#279)
1 parent fb4f255 commit 05a1b32

File tree

3 files changed

+21
-7
lines changed

3 files changed

+21
-7
lines changed

R/theme.R

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,13 @@
33
#' Create a theme using background and foreground colors (`theme_colors_*`) or
44
#' using a **brand.yml** file (`theme_brand_*`).
55
#'
6-
#' The use of the theme will depend on the package. See the vignettes for
7-
#' usage examples.
6+
#' The use of the theme will depend on the package. Please see
7+
#' [light/dark renderings examples](https://examples.quarto.pub/lightdark-renderings-examples/ggplot2.html)
8+
#' for examples using each supported package with dark mode, `theme_brand_*`,
9+
#' and `renderings: [light, dark]`,
10+
#' or [theme helper vignetes](https://quarto-dev.github.io/quarto-r/articles/theme-helpers.html)
11+
#' for examples using each package and `theme_colors_*` to specify the
12+
#' background and foreground colors directly.
813
#'
914
#' @param bg The background color
1015
#' @param fg The foreground color

man/theme_helpers.Rd

Lines changed: 7 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/articles/theme-helpers.qmd

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,17 @@ vignette: >
1111

1212
## Overview
1313

14-
The **quarto** package includes functions to help you theme plotting and table packages, for example to provide [light and dark renderings](https://quarto.org/docs/computations/execution-options.html#cell-renderings).
14+
The **quarto** package includes helper functions for theming plotting and table packages.
1515

1616
The functions return theme objects or functions, which are applied differently depending on the package.
1717

18-
This vignette demonstrates adding background and foreground colors to outputs from each package.
18+
These are simple helper functions to get you started. Copy them if you to customize them further.
1919

20-
These are very simple helper functions to get you started. If you need to customize them further, these functions can be copied from quarto-r.
20+
This vignette demonstrates adding background and foreground colors to outputs from each package using the `theme_colors_*` functions.
21+
22+
Please see
23+
[light/dark renderings examples](https://examples.quarto.pub/lightdark-renderings-examples/ggplot2.html)
24+
for examples using each supported package with dark mode, `theme_brand_*`, and [`renderings: [light, dark]`](https://quarto.org/docs/computations/execution-options.html#cell-renderings)
2125

2226
## flextable
2327

0 commit comments

Comments
 (0)