Skip to content

Commit 3c7cbe9

Browse files
add basic theme api docs to README.md
temporary - will move to quartodoc later
1 parent 4906dbb commit 3c7cbe9

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,36 @@ Python interface to the Quarto CLI (https://quarto-dev/quarto-cli).
44

55

66

7+
## theme helpers
8+
9+
`quarto-python` contains theme helpers to do basic background/foreground theming of plots and tables
10+
11+
The `theme_colors_*` functions take background and foreground colors:
12+
13+
| parameter | description |
14+
| --------- | ----------- |
15+
| `bg` | background color |
16+
| `fg` | foreground color |
17+
18+
The `theme_brand_*` functions take a [brand.yml](https://posit-dev.github.io/brand-yml/) file:
19+
20+
| parameter | description |
21+
| --------- | ----------- |
22+
| `brand_yml` | path to **brand.yml** file |
23+
24+
Available theme helpers:
25+
26+
| colors | brand |
27+
| --------- | ----------- |
28+
| `theme_colors_altair` | `theme_brand_altair` |
29+
| `theme_colors_bokeh` | `theme_brand_bokeh` |
30+
| `theme_colors_great_tables` | `theme_brand_great_tables` |
31+
| `theme_colors_matplotlib` | `theme_brand_matplotlib` |
32+
| `theme_colors_plotnine` | `theme_brand_plotnine` |
33+
| `theme_colors_plotly` | `theme_brand_plotly` |
34+
| `theme_colors_pygal` | `theme_brand_pygal` |
35+
| `theme_colors_seaborn` | `theme_brand_seaborn` |
36+
37+
The usage of the returned object or function depends on the package. See this repo for usage examples:
38+
39+
https://github.com/quarto-dev/quarto-examples/tree/main/renderings

0 commit comments

Comments
 (0)