Add GitHub emojis support (#158)

This commit is contained in:
Simon Lecoq
2021-02-27 14:39:51 +01:00
committed by GitHub
parent dd29f304fc
commit 42cbc6f1cd
8 changed files with 1863 additions and 3 deletions

View File

@@ -39,6 +39,22 @@ Omitted one will be appended using default order.
config_order: base.header, isocalendar, languages, stars
```
### 🥳 Render GitHub custom emojis
GitHub provide additional emojis which are not registered in Unicode standard (:octocat:, :shipit:, :trollface:, ...).
You can choose to render (or not) [GitHub emojis](https://github.com/github/gemoji).
It may increase filesize since it replace special strings by base64 images.
#### Examples workflows
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
config_gemoji: yes
```
### 🙂 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.

View File

@@ -96,6 +96,13 @@ inputs:
type: boolean
default: no
# Render GitHub custom emojis (like ":octocat:", see full list at https://api.github.com/emojis)
# May increase filesize
config_gemoji:
description: Use GitHub custom emojis
type: boolean
default: yes
# Enable SVG CSS animations
config_animations:
description: SVG CSS animations

View File

@@ -16,6 +16,12 @@
token: MOCKED_TOKEN
config_twemoji: yes
- name: Use gemoji
uses: lowlighter/metrics@latest
with:
token: MOCKED_TOKEN
config_gemoji: yes
- name: Disable animations
uses: lowlighter/metrics@latest
with: