Skip to content

Commit e7e5ffa

Browse files
committed
docs: update README.md
1 parent 4f1fbbc commit e7e5ffa

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,24 @@ None of the fields are required. Every query parameter has a default value displ
6767
| **lineCount** | `?lineCount=2` | 1 | The number of lines you want to add to your card. |
6868
| **line{n}** | `?line1=html5,html5,auto` | - | The current line of the badge, where {n} is a number. *`(1 <= n <= lineCount)`* |
6969

70+
71+
You can customize a theme using these query parameters.
72+
These parameters accept only valid hexadecimal colors, otherwise they are not applied. Please use `%23` instead of `#`.
73+
74+
> **Warning**
75+
> If the `?theme=` parameter is specified, any of these color customizations will override the theme's values.
76+
77+
| Parameter | Example | Description |
78+
|-----------|---------|-------------|
79+
| **bg** | `?bg=%2383324c` | The color of the background. |
80+
| **border** | `?border=%232da7c7` | The color of the border. |
81+
7082
<hr>
7183

7284
## 🪁 Themes
7385
These cards come with several built-in themes you can use. You can find all of them by clicking [here](docs/THEMES.md).
74-
If you would like to use other themes, and add one for yourself and others, please check this [issue](https://github.com/0l1v3rr/github-readme-tech-stack/issues/2).
86+
You can customize a theme for yourself using the [query parameters](#-query-parameters).
87+
If you would like to use other themes, and add one for yourself and others, please check this [issue](https://github.com/0l1v3rr/github-readme-tech-stack/issues/2).
7588

7689
<hr>
7790

docs/THEMES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Supported themes
22

33
Here are the currently supported themes spread in a table.
4-
If none of these themes fit your needs, feel free to [add one.](https://github.com/0l1v3rr/github-readme-tech-stack/issues/2) Every new theme is welcomed.
4+
If you would like to use other themes, and add one for yourself and others, please check this [issue](https://github.com/0l1v3rr/github-readme-tech-stack/issues/2).
55

66
<table>
77
<tr>

0 commit comments

Comments
 (0)