Update documentation

This commit is contained in:
lowlighter
2021-04-26 22:28:39 +02:00
parent 44cfde6845
commit 445902e854
4 changed files with 46 additions and 5 deletions

View File

@@ -25,12 +25,25 @@ For convenience, several useful properties are aliased in [/source/templates/mar
#### Examples workflows
```yaml
# Markdown output
- uses: lowlighter/metrics@latest
with:
# ... other options
template: markdown
filename: README.md # Output file
markdown: TEMPLATE.md # Template file
markdown_cache: .cache # Cache folder
config_output: markdown # Output as markdown file
filename: README.md # Output file
markdown: TEMPLATE.md # Template file
markdown_cache: .cache # Cache folder
config_output: markdown # Output as markdown file
```
```yaml
# PDF output
- uses: lowlighter/metrics@latest
with:
# ... other options
template: markdown
filename: render.pdf # Output file
markdown: TEMPLATE.md # Template file
markdown_cache: .cache # Cache folder
config_output: markdown-pdf # Output as pdf file
```