docs: update quickstart utilities [skip ci]

This commit is contained in:
lowlighter
2022-01-15 14:51:19 -05:00
parent 54590f152d
commit ea8723c7dd
5 changed files with 35 additions and 35 deletions

View File

@@ -1,19 +1,12 @@
### 🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>
<!--header-->
<!--/header-->
<table>
<td align="center">
<img src="">
<img width="900" height="1" alt="">
</td>
</table>
## ➡️ Available options
#### Examples workflows
<!--options-->
<!--/options-->
[➡️ Available options for this plugin](metadata.yml)
## Examples workflows
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
plugin_<%= name %>: yes
```
<!--examples-->
<!--/examples-->

View File

@@ -1,7 +1,9 @@
- name: <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %> plugin (default)
- name: Example
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.<%= name %>.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ""
plugin_<%= name %>: yes
prod:
skip: true

View File

@@ -1,14 +1,16 @@
name: "🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>"
category: community # Leave as it
category: community
description: Short description
examples:
default: https://via.placeholder.com/468x60?text=No%20preview%20available
supports:
- user # Support users account
- organization # Support organizations account
- repository # Support repositories metrics
scopes: [] # Required scopes for personal access token
- user
- organization
- repository
scopes: []
inputs:
# Enable or disable plugin
plugin_<%= name %>:
description: description
description: Enable <%= name %> plugin
type: boolean
default: no

View File

@@ -2,6 +2,7 @@
<defs><style><%%= fonts %></style></defs>
<style data-optimizable="true"><%%= style %></style>
<style><%= extras.css %></style>
<foreignObject x="0" y="0" width="100%" height="100%">
<div xmlns="http://www.w3.org/1999/xhtml" xmlns:xlink="http://www.w3.org/1999/xlink">

Before

Width:  |  Height:  |  Size: 562 B

After

Width:  |  Height:  |  Size: 597 B

View File

@@ -1,14 +1,16 @@
name: "🖼️ Template name"
extends: classic # Fallback to "classic" template "template.mjs" if not trusted
index: ~ # Leave as it (this is used to order plugins on metrics README.md)
extends: classic
description: Short description
examples:
default: https://via.placeholder.com/468x60?text=No%20preview%20available
supports:
- user # Support users account
- organization # Support organizations account
- repository # Support repositories metrics
- user
- organization
- repository
formats:
- svg # Support SVG output
- png # Support PNG output
- jpeg # Support JPEG output
- json # Support JSON output
- markdown # Support markdown output
- markdown-pdf # Support PDF output
- svg
- png
- jpeg
- json
- markdown
- markdown-pdf