Skip to content

theme helpers: provide links to examples #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions R/theme.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,13 @@
#' Create a theme using background and foreground colors (`theme_colors_*`) or
#' using a **brand.yml** file (`theme_brand_*`).
#'
#' The use of the theme will depend on the package. See the vignettes for
#' usage examples.
#' The use of the theme will depend on the package. Please see
#' [light/dark renderings examples](https://examples.quarto.pub/lightdark-renderings-examples/ggplot2.html)
#' for examples using each supported package with dark mode, `theme_brand_*`,
#' and `renderings: [light, dark]`,
#' or [theme helper vignetes](https://quarto-dev.github.io/quarto-r/articles/theme-helpers.html)
#' for examples using each package and `theme_colors_*` to specify the
#' background and foreground colors directly.
#'
#' @param bg The background color
#' @param fg The foreground color
Expand Down
9 changes: 7 additions & 2 deletions man/theme_helpers.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions vignettes/articles/theme-helpers.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,17 @@ vignette: >

## Overview

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).
The **quarto** package includes helper functions for theming plotting and table packages.

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

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

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.
This vignette demonstrates adding background and foreground colors to outputs from each package using the `theme_colors_*` functions.

Please see
[light/dark renderings examples](https://examples.quarto.pub/lightdark-renderings-examples/ggplot2.html)
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)

## flextable

Expand Down
Loading