38 lines
2.0 KiB
Markdown
38 lines
2.0 KiB
Markdown
# badgedex
|
||
|
||
BadgeDex
|
||
|
||
# BadgeDex API – URL Paraméterek
|
||
|
||
Az alábbi paraméterekkel szabályozhatod a `/badge` végpont működését:
|
||
|
||
| Paraméter | Alapértelmezett érték | Leírás | Példa értékek |
|
||
|-------------|-----------------------|----------------------------------------------------------------------------------------|------------------------------|
|
||
| `icon` | `portainer` | A SimpleIcons ikon neve (kisbetű, kötőjellel). | `github`, `docker`, `nginx` |
|
||
| `label` | `Portainer` | A badge-en megjelenő szöveg. | `MyApp`, `Status` |
|
||
| `bg` | `#f0f0f0` | Háttérszín (hex vagy CSS színnév). | `#fff`, `#222`, `red` |
|
||
| `color` | `#000000` | Szöveg színe (hex vagy CSS színnév). Harmonizál az icon szinével ha nem kérünk külön. | `#333`, `white` |
|
||
| `size` | `24` | Ikon (és badge) magassága pixelben. | `16`, `32`, `64` |
|
||
| `labelpos` | `right` | Szöveg pozíciója az ikonhoz képest: `right`, `left`, `above`, `below`. | `left`, `above` |
|
||
| `fontweight`| `normal` | Szöveg vastagsága (`normal`, `bold`, `lighter`, szám is lehet pl. `600`). | `bold`, `600` |
|
||
|
||
## Példák
|
||
|
||
- **Alap badge:**
|
||
`/badge`
|
||
|
||
- **GitHub ikon, piros háttér, fehér szöveg:**
|
||
`/badge?icon=github&bg=red&color=white`
|
||
|
||
- **Szöveg balra, ikon jobbra:**
|
||
`/badge?labelpos=left`
|
||
|
||
- **Szöveg az ikon fölött, félkövér betű:**
|
||
`/badge?labelpos=above&fontweight=bold`
|
||
|
||
- **Nagyobb ikon és szöveg:**
|
||
`/badge?size=48`
|
||
|
||
---
|
||
|
||
A badge SVG formátumban tér vissza, így közvetlenül beilleszthető HTML-be vagy Markdown |