Add config_display option to support regular and large renders (#310)
This commit is contained in:
@@ -140,6 +140,21 @@ It may increase filesize since it replace unicode characters by SVG images.
|
||||
config_twemoji: yes
|
||||
```
|
||||
|
||||
### ↔️ Controlling display size
|
||||
|
||||
Some templates like `classic` and `repositories` support different output display size:
|
||||
- `regular` (default) will render a medium-sized image, which is suitable for both desktop and mobile displays and is preferable when using data-intensive metrics (since text may be scaled down on small devices)
|
||||
- `large` will render a large-sized image, which may be more suitable for some plugins (like displaying topics icons, repository contributors, etc.)
|
||||
|
||||
#### ℹ️ Examples workflows
|
||||
|
||||
```yaml
|
||||
- uses: lowlighter/metrics@latest
|
||||
with:
|
||||
# ... other options
|
||||
config_display: large
|
||||
```
|
||||
|
||||
### 🎞️ SVG CSS Animations
|
||||
|
||||
As rendered metrics use HTML and CSS, some templates have animations.
|
||||
|
||||
Reference in New Issue
Block a user