Add option to use twemojis instead of emojis (#121)

This commit is contained in:
Simon Lecoq
2021-02-10 19:57:01 +01:00
committed by GitHub
parent 4ba1e46fb3
commit 7f83f78dcf
9 changed files with 60 additions and 0 deletions

View File

@@ -39,6 +39,21 @@ Omitted one will be appended using default order.
config_order: base.header, isocalendar, languages, stars
```
### 🙂 Using twemojis instead of emojis
You can choose to use [twemojis](https://github.com/twitter/twemoji) instead of regular emojis so rendered metrics are more consistent across all platforms.
It may increase filesize since it replace unicode characters by SVG images.
#### Examples workflows
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
config_twemoji: yes
```
### 🎞️ SVG CSS Animations
As rendered metrics use HTML and CSS, some templates have animations.

View File

@@ -88,6 +88,13 @@ inputs:
format: comma-separated
default: ""
# Use twemojis instead of emojis
# May increase filesize but emojis will be rendered the same across all platforms
config_twemoji:
description: Use twemojis instead of emojis
type: boolean
default: no
# Enable SVG CSS animations
config_animations:
description: SVG CSS animations

View File

@@ -10,6 +10,12 @@
token: MOCKED_TOKEN
config_output: png
- name: Use twemoji
uses: lowlighter/metrics@latest
with:
token: MOCKED_TOKEN
config_twemoji: yes
- name: Disable animations
uses: lowlighter/metrics@latest
with: