Include general structure in configuration documentation

This commit is contained in:
Swexti 2020-10-27 10:17:38 +01:00 committed by GitHub
parent dd3c50f3ac
commit c8ff2ce4f4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -20,10 +20,33 @@ $HOME
└──eww.scss
```
### Config structure
Your config structure should look like this:
```xml
<eww>
<definitions>
<!-- Put your <def>'s in here -->
</definitions>
<variables>
<!-- Put your <script-var> and <var>'s in here -->
</variables>
<windows>
<!-- Put your window blocks here -->
</windows>
</eww>
```
See [The `<definitons>` block](#the-definitions-block),
[Variables](#variables) and the
[The `<windows>` block](#the-windows-block).
### Variables
If you create a `<var>` or a `<script-var>`, you can reference them in your `<box>` by doing `{{var}}`. Where `var` is your variable name.
#### The `<var>` tag
Allows you to repeat the same text multiple times through without retyping it multiple times.