sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update markdown documentation

Browse Source
This commit is contained in:
lowlighter
2021-05-18 22:59:38 +02:00
parent ed0da41973
commit 98de580429
2 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
source/templates/markdown/example.md
View File

@@ -50,9 +50,16 @@ ___
To include SVGs metrics images without creating additional jobs, use the `embed` function:
<%- await embed(`example-isocalendar`, {isocalendar:true, isocalendar_duration:"full-year"}) %>
<%- await embed(`example-isocalendar`, {isocalendar:true, isocalendar_duration:"full-year", config_display:"large"}) %>
<%- await embed(`example-languages-pdf`, {languages:true, languages_details:"percentage, bytes-size", config_display:"large"}) %>
It takes two arguments:
- An unique identifier which will be used as filename withing `markdown_cache` folder
- Configuration options (see [action.yml](https://github.com/lowlighter/metrics/blob/master/action.yml))
- Tokens options are automatically passed down from your workflow job, do not pass them again
Note that unlike regular workflow jobs, `embed` function does not have `base` plugin enabled by default.
If you wish to diplay parts of it, they must be explicitely enabled:
<%- await embed(`example-base-pdf`, {base:"activity, community, repositories"}) %>