Format headers

This commit is contained in:
Michael Aquilina 2019-08-24 21:46:56 +01:00
parent dd3da7b6ef
commit df83404c8c
No known key found for this signature in database
GPG Key ID: 636066730B056BD1
4 changed files with 18 additions and 16 deletions

View File

@ -8,7 +8,7 @@ waybar - backlight module
The *backlight* module displays the current backlight level. The *backlight* module displays the current backlight level.
# Config # CONFIGURATION
*interval* ++ *interval* ++
typeof: integer ++ typeof: integer ++
@ -52,7 +52,7 @@ The *backlight* module displays the current backlight level.
typeof: double typeof: double
Threshold to be used when scrolling. Threshold to be used when scrolling.
# Example: # EXAMPLE:
``` ```
"backlight": { "backlight": {
@ -60,9 +60,8 @@ The *backlight* module displays the current backlight level.
"format": "{percent}% {icon}", "format": "{percent}% {icon}",
"format-icons": ["", ""] "format-icons": ["", ""]
} }
``` ```
# Style # STYLE
- *#backlight* - *#backlight*

View File

@ -8,6 +8,8 @@ waybar - battery module
The *battery* module displays the current capacity and state (eg. charging) of your battery. The *battery* module displays the current capacity and state (eg. charging) of your battery.
# CONFIGURATION
*bat* ++ *bat* ++
typeof: string ++ typeof: string ++
The battery to monitor, as in /sys/class/power_supply/ instead of auto detect. The battery to monitor, as in /sys/class/power_supply/ instead of auto detect.
@ -68,7 +70,7 @@ The *battery* module displays the current capacity and state (eg. charging) of y
default: true ++ default: true ++
Option to disable tooltip on hover. Option to disable tooltip on hover.
# Format Replacements: # FORMAT REPLACEMENTS
*{capacity}*: Capacity in percentage *{capacity}*: Capacity in percentage
@ -76,7 +78,7 @@ The *battery* module displays the current capacity and state (eg. charging) of y
*{time}*: Estimate of time until full or empty. Note that this is based on the power draw at the last refresh time, not an average. *{time}*: Estimate of time until full or empty. Note that this is based on the power draw at the last refresh time, not an average.
# Custom Formats: # CUSTOM FORMATS
The *battery* module allows to define custom formats based on up to two factors. The best fitting format will be selected. The *battery* module allows to define custom formats based on up to two factors. The best fitting format will be selected.
@ -86,7 +88,7 @@ The *battery* module allows to define custom formats based on up to two factors.
*format-<status>-<state>*: You can also set a custom format depending on both values. *format-<status>-<state>*: You can also set a custom format depending on both values.
# States: # STATES
- Every entry (*state*) consists of a *<name>* (typeof: *string*) and a *<value>* (typeof: *integer*). - Every entry (*state*) consists of a *<name>* (typeof: *string*) and a *<value>* (typeof: *integer*).
- The state can be addressed as a CSS class in the *style.css*. The name of the CSS class is the *<name>* of the state. Each class gets activated when the current capacity is equal or below the configured *<value>*. - The state can be addressed as a CSS class in the *style.css*. The name of the CSS class is the *<name>* of the state. Each class gets activated when the current capacity is equal or below the configured *<value>*.
@ -94,7 +96,7 @@ The *battery* module allows to define custom formats based on up to two factors.
# Example: # EXAMPLE
``` ```
"battery": { "battery": {
@ -110,7 +112,7 @@ The *battery* module allows to define custom formats based on up to two factors.
} }
``` ```
# Style # STYLE
- *#battery* - *#battery*
- *#battery.<status>* - *#battery.<status>*

View File

@ -8,6 +8,8 @@ waybar - clock module
The *clock* module displays the current date and time. The *clock* module displays the current date and time.
# CONFIGURATION
*interval*: ++ *interval*: ++
typeof: integer ++ typeof: integer ++
default: 60 ++ default: 60 ++
@ -48,7 +50,7 @@ The *clock* module displays the current date and time.
View all valid format options in *strftime(3)*. View all valid format options in *strftime(3)*.
# Example: # EXAMPLE
``` ```
"clock": { "clock": {
@ -56,9 +58,8 @@ View all valid format options in *strftime(3)*.
"format": "{:%H:%M}", "format": "{:%H:%M}",
"max-length": 25 "max-length": 25
} }
``` ```
# Style # STYLE
- *#clock* - *#clock*

View File

@ -17,7 +17,7 @@ Valid directories for this file are:
A good starting point is the default config found at https://github.com/Alexays/Waybar/blob/master/resources/config. A good starting point is the default config found at https://github.com/Alexays/Waybar/blob/master/resources/config.
Also a minimal example config can be found on the at the bottom of this man page. Also a minimal example config can be found on the at the bottom of this man page.
# Bar Config # BAR CONFIG
*layer* ++ *layer* ++
typeof: string ++ typeof: string ++
@ -74,7 +74,7 @@ e.g.
``` ```
"format": "<span style=\"italic\">{}</span>" "format": "<span style=\"italic\">{}</span>"
``` ```
# Multiple instances of a module # MULTIPLE INSTANCES OF A MODULE
If you want to have a second instance of a module, you can suffix it by a '#' and a custom name. If you want to have a second instance of a module, you can suffix it by a '#' and a custom name.
For example if you want a second battery module, you can add `"battery#bat2"` to your modules. For example if you want a second battery module, you can add `"battery#bat2"` to your modules.
@ -92,7 +92,7 @@ This could then look something like this *(this is an incomplete example)*:
} }
``` ```
# Minimal config # MINIMAL CONFIG
A minimal *config* file could look like this: A minimal *config* file could look like this:
@ -115,7 +115,7 @@ A minimal *config* file could look like this:
} }
``` ```
# Multi output config # MULTI OUTPUT CONFIG
## Limit a configuration to some outputs ## Limit a configuration to some outputs