Skip to content

Commit

Permalink
docs: update themes documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
deponian committed Oct 27, 2024
1 parent 81dcc14 commit b1be073
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ themes:
# . . .
```

`themes` is the place where you apply colors and style to log formats, patterns and word groups you defined earlier. Every capture group can be colorized using `fg`, `bg` and `style` fields.
`themes` is the place where you apply colors and style to log formats, patterns and word groups you defined earlier (or to the built-in ones). Every capture group can be colorized using `fg`, `bg` and `style` fields.

`fg` and `bg` are foreground and background colors correspondingly. They can be a hex value like `#ff0000` or a number between 0 and 255 for ANSI colors.

Expand Down Expand Up @@ -450,11 +450,8 @@ themes:

#### I want to define and use my own theme

1. Get current configuration to use it as an example:
```sh
logalize --print-config > example.logalize.yaml
```
2. Copy one of the built-in themes from `example.logalize.yaml` to your `logalize.yaml`, rename it and change it the way you like it:
1. Use one of the existing themes as an example. Pick one [here](themes/)
2. Copy it to your `logalize.yaml`, rename and change the way you like it:
```yaml
# . . .
themes:
Expand All @@ -479,6 +476,7 @@ settings:
```sh
cat logs | logalize --theme "your-theme-name"
```
5. If it's a well known theme and you think others might benefit from it, feel free to open a PR asking to add that theme as one of the built-in themes

#### I want to disable all builtins and use only data from my own `logalize.yaml`

Expand Down

0 comments on commit b1be073

Please sign in to comment.