Debian Codegraph @

docs/config/config-variables.md

raw
1 # Variables entry
2
3 The **variables** entry (optional) contains a variables mapping (See [variables](config-file.md#variables)).
4
5 ```yaml
6 variables:
7 <variable-name>: <variable-content>
8 ```
9
10 Variables defined in the `variables` entry are made available within the config file.
11
12 For example
13 ```yaml
14 variables:
15 myvar: "some value"
16 home: "{{@@ env['HOME'] @@}}"
17 email: "[email protected]"
18 ```
19
20 Config variables are recursively evaluated, which means that
21 a config like the below:
22 ```yaml
23 variables:
24 var1: "var1"
25 var2: "{{@@ var1 @@}} var2"
26 var3: "{{@@ var2 @@}} var3"
27 var4: "{{@@ dvar4 @@}}"
28 dynvariables:
29 dvar1: "echo dvar1"
30 dvar2: "{{@@ dvar1 @@}} dvar2"
31 dvar3: "{{@@ dvar2 @@}} dvar3"
32 dvar4: "echo {{@@ var3 @@}}"
33 ```
34
35 will result in the following available variables:
36
37 * var1: `var1`
38 * var2: `var1 var2`
39 * var3: `var1 var2 var3`
40 * var4: `echo var1 var2 var3`
41 * dvar1: `dvar1`
42 * dvar2: `dvar1 dvar2`
43 * dvar3: `dvar1 dvar2 dvar3`
44 * dvar4: `var1 var2 var3`
45
46 Config variables can be nested as shown below:
47 ```yaml
48 variables:
49 rofi:
50 background_color: "rgba ( 33, 33, 33, 100 % );"
51 polybar:
52 background_color: "#cc222222"
53 ```
54
55 Where the above would be referenced using `{{@@ rofi.background_color @@}}`
56 and `{{@@ polybar.background_color @@}}`.