Update README.md

This commit is contained in:
lowlighter
2021-01-11 22:33:46 +01:00
parent 42327f265f
commit 0df3f23fe8

View File

@@ -1458,6 +1458,26 @@ It is possible to set set your timezone (see [here](https://en.wikipedia.org/wik
config_timezone: Europe/Paris
```
#### 📦 Ordering content
🚧 This feature is available as pre-release on @master branch (unstable)
It is possible to order metrics content by adding the following to your workflow:
```yaml
- uses: lowlighter/metrics@master
with:
# ... other options
base: header
plugin_isocalendar: yes
plugin_languages: yes
plugin_stars: yes
config_order: base.header, isocalendar, languages, stars
```
Content ordering is done through "[partials](https://github.com/lowlighter/metrics/blob/master/source/templates/classic/partials/_.json)", which are actually content chunks of generated metrics, which may vary from one template to another.
It is not mandatory to specify all partials, rest will automatically be appendend in default order.
#### 🔲 Adjust padding
Generated metrics height is computed after being rendered through an headless browser. As rendering can depends on used fonts and operating system, it may render as cropped or with additional blank space at the bottom.
@@ -1475,6 +1495,18 @@ Both positive and negative values are accepted, but you must specify a percentag
If you specify a single value, it'll be used as for both width and height padding.
When two values are specified separated by a comma, the first one will be used for width and the second for height.
#### 🎋 Using a specific branch instead of default
🚧 This feature is available as pre-release on @master branch (unstable)
Is is possible to commit generated metrics in a specific branch rather than default branch by adding the following to your workflow:
```yaml
- uses: lowlighter/metrics@master
with:
# ... other options
committer_branch: my-branch
```
#### 💱 Convert output to PNG/JPEG
It is possible to convert output from SVG to PNG or JPEG images by adding the following to your workflow: