doc: decorations: document the new ‘border’ decoration

This commit is contained in:
Daniel Eklöf 2021-10-23 12:17:00 +02:00
parent f0782d5124
commit 134141b7c5
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F

View file

@ -70,6 +70,39 @@ content:
color: ff0000ff color: ff0000ff
``` ```
# BORDER
This decoration renders a border of configurable size (i.e border
width) around the particle.
## CONFIGURATION
[[ *Name*
:[ *Type*
:[ *Req*
:[ *Description*
| color
: color
: yes
: The color of the line. See *yambar*(5) for format.
| size
: int
: no
: Border width, in pixels. Defaults to 1px.
## EXAMPLES
```
content:
string:
deco:
border:
size: 2
color: ff0000ff
```
# STACK # STACK
This particles combines multiple decorations. This particles combines multiple decorations.