You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/authoring/brand.qmd
+42Lines changed: 42 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -59,6 +59,8 @@ View the example: [Source](https://github.com/cwickham/quarto-examples/tree/bran
59
59
60
60
On this page:
61
61
62
+
- Learn how to add a brand file
63
+
62
64
- Learn about the elements of **brand.yml** and how they are used in Quarto.
63
65
64
66
- Learn how to access brand values outside of the brand file.
@@ -73,6 +75,46 @@ The **brand.yml** specification is an active area of work at Posit. Quarto's sup
73
75
Currently, the formats that support **brand.yml** are: `html`, `dashboard`, `revealjs` and `typst`.
74
76
:::
75
77
78
+
## Applying Brand
79
+
80
+
To specify a brand, create a `_brand.yml` file in the root directory of your project. *Do you need a project? Do we reccommend a project? *
81
+
Quarto will detect the presence of `_brand.yml` and automatically apply the brand to all documents of the supported formats in the project.
82
+
83
+
You can also set, or override, brand settings in a document by specifying brand elements under the `brand` option:
84
+
85
+
```{.yaml filename="document.qmd"}
86
+
---
87
+
brand:
88
+
color:
89
+
background: "#ffffff"
90
+
---
91
+
```
92
+
93
+
You can disable brand for a document by setting `brand: false`:
94
+
95
+
```{.yaml filename="document.qmd"}
96
+
---
97
+
brand: false
98
+
---
99
+
```
100
+
101
+
You can put `_brand.yml` in a subdirectory of your project, and then use the `brand` key to specify the path to the brand file.
102
+
For example, to the the brand file at `brand/_brand.yml` for a single document, add `brand` to the header:
103
+
104
+
```{.yaml filename="document.qmd"}
105
+
---
106
+
brand: brand/_brand.yml
107
+
---
108
+
```
109
+
110
+
To use the brand file at `brand/_brand.yml` for all documents in the project add `brand` to `_quarto.yml`:
111
+
112
+
```{.yaml filename="_quarto.yml"}
113
+
brand: brand/_brand.yml
114
+
```
115
+
116
+
Paths specified in `_brand.yml` are relative to the location of the brand file. (*Is this true?*)
117
+
76
118
## Brand Elements
77
119
78
120
The elements of **brand.yml** are specified in the specification at <https://posit-dev.github.io/brand-yml/>. In this section, learn how these elements are used in Quarto.
0 commit comments