Skip to content

Commit f1cfc29

Browse files
committed
docs: clarify config
1 parent a125017 commit f1cfc29

1 file changed

Lines changed: 12 additions & 18 deletions

File tree

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,6 @@ Call `styler` to generate the CSS.
4646
styler
4747
```
4848

49-
- Media queries are suffixed with `@` e.g.: `md@`, `lg@`
50-
- States are suffixed with `:`, e.g.: `hover:`, `active:`
51-
- Numeric values are set as `unit` specified in the config (defaults to `rem`)
52-
and are divided by the `divider` specified in the config (defaults to `4`),
53-
e.g.: `padding-top-2` will result in `padding-top: 0.5rem`
54-
- Numerics precded by `~` are treated as strict and are not divided or suffixed with `unit`
55-
e.g.: `flex~1` results in `flex: 1`
56-
- Media queries can be edited in `.styler` config file
57-
- Colors can be edited in `.styler` config file
58-
- Extracted CSS properties are checked against the [W3C CSS Properties](https://www.w3.org/Style/CSS/all-properties.en.html) table
59-
6049
## Configuration
6150

6251
Styler can be customized through the `.styler` configuration file. You can create a default configuration with:
@@ -397,19 +386,24 @@ The configuration allows you to customize:
397386
}
398387
}
399388
```
400-
/details>
401-
402-
## Advanced Property Values
389+
</details>
403390

404-
Styler now supports complex CSS property values with multiple components:
391+
## Property Values
405392

393+
- Media queries are suffixed with `@` e.g.: `md@`, `lg@`
394+
- States are suffixed with `:`, e.g.: `hover:`, `active:`
395+
- Numeric values are set as `unit` specified in the config (defaults to `rem`)
396+
and are divided by the `divider` specified in the config (defaults to `4`),
397+
e.g.: `padding-top-2` will result in `padding-top: 0.5rem`
398+
- Numerics precded by `~` are treated as strict and are not divided or suffixed with `unit`
399+
e.g.: `flex~1` results in `flex: 1`
400+
- Media queries can be edited in `.styler` config file
401+
- Colors can be edited in `.styler` config file
402+
- Extracted CSS properties are checked against the [W3C CSS Properties](https://www.w3.org/Style/CSS/all-properties.en.html) table
406403
- **Multiple Value Parts**: Create properties with multiple values like `box-shadow-1-2-4-red`
407404
which becomes `box-shadow: 0.25rem 0.5rem 1rem red`
408-
409405
- **Selective Strict Values**: Use `~` to mark specific parts as "strict" (no division or unit):
410406
- `border-1-solid-red``border: 0.25rem solid red` (number is divided by 4, unit added)
411407
- `border-~1-solid-red``border: 1 solid red` (strict number, no division or unit)
412408
- `border-1~solid-red``border: 0.25rem solid red` (only affects the part with ~)
413409
- `box-shadow~1-2-2-grey``box-shadow: 1 0.5rem 0.5rem grey` (strict property name)
414-
415-
This approach gives you fine-grained control over how numeric values are processed.

0 commit comments

Comments
 (0)